README.md in dovico-1.1.0 vs README.md in dovico-1.2.0
- old
+ new
@@ -1,12 +1,19 @@
[](https://travis-ci.org/trainline-eu/dovico)
Repository for Dovico API management.
+# Requirements
+- Ruby 2.2.2 or newer
+
# Installation
+`gem install dovico`
+
+# Configuration
+
## Dovico authentication
-Dovico provide a way to generate a 3rd party token. This token provide a full access to your account:
+Dovico provide a way to generate a 3rd party token. This token provides a full access to your account:
- Do not expose your token.
- If you believe your token has been exposed publicly, regenerate a new one. The previous token will be invalidated.
To generate a token:
* Login to https://login.dovico.com/index.aspx
@@ -20,19 +27,15 @@
user_token: "<token you have copied from dovico.net page>"
# Your company's token
client_token: "<token given by your company's dovico admin>"
~~~
-## Install required libraries
-* Install Ruby 2.4.0
-* `make install`
-
## Setup your default timesheet
-* List the available tasks with `make tasks`
+* List the available tasks with `dovico --tasks`
~~~
-$ make tasks
+$ dovico --tasks
== List of available projects ==
Project | Task | Description
1200 | 100 | Sauron Project: Forge the One Ring
1200 | 110 | Sauron Project: Attack Gondor
1400 | 100 | Gandalf Project: Meet Bilbo
@@ -72,33 +75,82 @@
hours: 1
~~~
# Usage
## Display informations on your account
-`make myself`
+`dovico --myself`
+~~~
+$ dovico --myself
+Informations about yourself
+ - ID: 42
+ - First Name: Gandalf
+ - Last Name: The White
+~~~
+
## Display the list of the tasks
-`make tasks`
+`dovico --tasks`
+~~~
+$ dovico --tasks
+== List of available projects ==
+Project | Task | Description
+ 1200 | 100 | Sauron Project: Forge the One Ring
+ 1200 | 110 | Sauron Project: Attack Gondor
+ 1400 | 100 | Gandalf Project: Meet Bilbo
+ 1400 | 120 | Gandalf Project: Convince Frodo
+ 1600 | 100 | Frodo Project: Go home
+~~~
## Fill the timesheet
+`dovico --fill [date options]`
+
+The date options are detailed below. All the other commands use the same format for these date options.
+
### For the current week
-`make current_week`
+`dovico --fill --current_week`
### For today
-`make today`
+`dovico --fill --today`
### For a specific [commercial week](http://www.epochconverter.com/weeks/)
-`make week WEEK=49`
+`dovicon --fill --week=49`
Year can be set too:
-`make week YEAR=2015 WEEK=40`
+`dovico --fill --year=2015 --week=40`
### For a specific day
-`make day DAY=2017-12-31`
+`dovico --fill --day=2017-12-31`
-# Restrictions and known issues
-* The client can't edit already created timesheets for now.
+## Show the timesheet
+`dovico --show [date options]`
+~~~
+$ dovico --show --start=2017-01-02 --end=2017-01-12
+== List of Time Entries between 2017-01-02 and 2017-01-06 ==
+2017-01-02 [××××××××××××××] : [not_submitted] 7h Sauron Project: Forge the One Ring
+2017-01-03 [××××××××××××××] : [not_submitted] 7h Sauron Project: Attack Gondor
+2017-01-12 [××××] : [under_review] 2h Gandalf Project: Meet Bilbo
+2017-01-12 [××××××××] : [under_review] 4h Gandalf Project: Convince Frodo
+2017-01-12 [××] : [under_review] 1h Frodo Project: Go home
+~~~
+
+## Submit the timesheet
+`dovico --submit [date options]`
+
+Once submitted, the timesheet can't be edited.
+
+## Delete timesheet
+`dovico --clear [date options]`
+
+A confirmation will be asked before the deletion.
+~~~
+$ dovico --clear --day=2017-01-05
+• 1 Time Entries to be deleted. Are you sure? (yes/no)
+yes
+✓ 1 Time Entries deleted
+~~~
+
+# Contributing
You are warmly welcome to contribute to the project!
# Dovico API Documentation
* http://apideveloper.dovico.com/