summaryrefslogtreecommitdiff
path: root/plugins/Timetrackingeditor/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Timetrackingeditor/README.md')
-rw-r--r--plugins/Timetrackingeditor/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/plugins/Timetrackingeditor/README.md b/plugins/Timetrackingeditor/README.md
new file mode 100644
index 00000000..68907fc0
--- /dev/null
+++ b/plugins/Timetrackingeditor/README.md
@@ -0,0 +1,40 @@
+Timetrackingeditor
+==================
+
+
+Allows manual adding and editon of Timetracking Entries
+
+Author
+------
+
+- Thomas Stinner
+
+Requirements
+------------
+
+- Kanboard >= 1.0.38 (not testet with older versions)
+
+
+Installation
+------------
+
+You have the choice between 3 methods:
+
+1. Install the plugin from the Kanboard plugin manager in one click
+2. Download the zip file and decompress everything under the directory `plugins/Timetrackingeditor`
+3. Clone this repository into the folder `plugins/Timetrackingeditor`
+
+Note: Plugin folder is case-sensitive.
+
+
+Documentation
+-------------
+
+With this plugin you are able to edit, remove and manually create entries in the Time Tracking Table.
+
+Just go to a subtask, select "Time Tracking" (only visible if you have entered either an estimate and/or time spent value for the Task). Now you have the opportunity to add/remove/delete entries. You are only allowed to remove and edit your own entries.
+
+You can also add comments to every Time Tracking entry and select if the time is billable or not. Entries that have been selected as billable have a shopping cart symbol.
+
+Additionally you can export all time tracking entries as an HTML table (which makes it easy to import to excel) using the command ``` kanboard export:allsubtaskstimetracking```
+