megaphone/tbusainvoicegen
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fill in README

Browse Source
This commit is contained in:
Jon Goldberg 2019-06-28 18:11:04 -04:00
parent 53ca44bcb6
commit 21dc82fa19
No known key found for this signature in database
GPG Key ID: C2D2247364F9DB13
1 changed files with 12 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,44 +1,22 @@
# tbusainvoicegen
# Timebanks USA Invoice Generator
![Screenshot](/images/screenshot.png)
(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
This extension will generate invoices for Community Weaver 3 for a specified billing period,
automatically determining which timebanks need an invoice and calculating the amount.
The extension is licensed under [AGPL-3.0](LICENSE.txt).
## Requirements
* PHP v5.6+
* CiviCRM (*FIXME: Version number*)
## Installation (Web UI)
This extension has not yet been published for installation via the web UI.
## Installation (CLI, Zip)
Sysadmins and developers may download the `.zip` file for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).
```bash
cd <extension-dir>
cv dl tbusainvoicegen@https://github.com/FIXME/tbusainvoicegen/archive/master.zip
```
## Installation (CLI, Git)
Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
install it with the command-line tool [cv](https://github.com/civicrm/cv).
```bash
git clone https://github.com/FIXME/tbusainvoicegen.git
cv en tbusainvoicegen
```
* PHP v5.5+
* CiviCRM 5.7+
## Usage
(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
## Known Issues
(* FIXME *)
There is no UI for now. Instead:
* Go to **Support menu » Developer » API Explorer**.
* Set *Entity* to **Invoicegen** and *Action* to **Generate**.
* Enter a billing period in the following format: "2019-2"
* First number is the year; second is 1 for Jan-Jun, 2 for Jul-Dec.
* Optionally, select **Add Parameter** and select a single contact ID. If you don't, all timebanks eligible to receive an invoice in this billing period will receive one (unless it already exists).
* Press **Execute**.