summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2015-06-08 16:20:21 -0700
committerelijah <elijah@riseup.net>2015-06-08 16:20:21 -0700
commitff46b9ac95eb7a53dacaed4e854964c2c4997ca8 (patch)
treefae6a6fdb36e1eb0a5ada0528afd482b556028ed /README.md
parent4d976166d360462b411545256a6b00eba3080a5a (diff)
* added totals
* better link * report header * configurable rate * version summary
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0ac14b3..8d0e4a3 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,20 @@ Installation:
Configuration:
* You grant the permission 'view reports' to a user in order to be able to view the report.
-* Create a custom field called 'Hour Budget'
+* Create a 'deliverable' tracker, available only to your reporting project.
+
+Custom fields:
+
+* Issues
+ * "Hour Budget": an integer field for 'deliverable' issues.
+ * "Price": an string field for 'deliverable' issues
+ (used to override the money amount displayed, if present).
+* Versions
+ * "Header URL": an string field for target versions.
+ If present, the image will be added to the report at the top.
+ * "Summary": a text field for Textile formatted summary
+ to appear at the top of a report ('description' is used for the heading).
+ * "Rate": a text field for the hourly rate, including currency ("$50").
License:
@@ -25,4 +38,4 @@ The same as Redmine (GNU GENERAL PUBLIC LICENSE Version 2)
Copyright:
-2015 (c) LEAP Encryption Access Project \ No newline at end of file
+2015 (c) LEAP Encryption Access Project