From 21dc82fa195bc407a90419280c710c98295e20af Mon Sep 17 00:00:00 2001
From: Jon Goldberg <jon@megaphonetech.com>
Date: Fri, 28 Jun 2019 18:11:04 -0400
Subject: [PATCH] fill in README

---
 README.md | 46 ++++++++++++----------------------------------
 1 file changed, 12 insertions(+), 34 deletions(-)

diff --git a/README.md b/README.md
index d3091c5..3fe8f29 100644
--- a/README.md
+++ b/README.md
@@ -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**.