summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 8d0e4a3..d62979a 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,17 @@ Configuration:
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).
+ * "Budgeted Hours": an integer field for 'deliverable' issues (hours).
+ If set, then a warning will be shown if the total hours is less.
+ * "Budgeted Cost": an text field for 'deliverable' issues (e.g. "$1000").
+ If set, then a warning will be shown if the total cost is less
+ (and "Budgeted Hours" is empty).
+ * "Fixed Cost": a text field for 'deliverable' issues. Fixed price for
+ deliverable, irrespective of labor (e.g. ignores the "Budgeted" fields).
* 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
+ * "Summary": a long 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").