Unsuck docs #2

Author: kriskbx

package.json

@@ -1,7 +1,14 @@
 {
   "name": "gitlab-time-tracker",
   "version": "1.3.0",
-  "description": "A CLI that makes working with GitLabs time tracking feature more enjoyable",
+  "description": "A command line interface for GitLabs time tracking feature.",
+  "bugs": {
+    "url": "https://github.com/kriskbx/gitlab-time-tracker/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kriskbx/gitlab-time-tracker.git"
+  },
   "main": "gtt.js",
   "scripts": {},
   "bin": {

readme.md

@@ -1,25 +1,29 @@
-# gtt [![npm](https://img.shields.io/npm/dt/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker) [![npm](https://img.shields.io/npm/v/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker)
+# gtt 
 
-> A command line interface that makes working with GitLabs time tracking feature more enjoyable.
+[![npm](https://img.shields.io/npm/dt/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker) [![npm](https://img.shields.io/npm/v/gitlab-time-tracker.svg?style=flat-square)](https://www.npmjs.com/package/gitlab-time-tracker) [![npm](https://img.shields.io/npm/l/gitlab-time-tracker.svg)](https://www.npmjs.com/package/gitlab-time-tracker)
+
+> A command line interface for GitLabs time tracking feature.
 
 gtt monitors the time you spent on an issue or merge request locally and syncs it to GitLab. 
-It also allows you to create time tracking reports in various formats from time tracking data
+It also allows you to create reports in various formats from time tracking data
 stored on GitLab.
 
 ## requirements
 
-* [node.js](https://nodejs.org/en/download) version > 6
+* [node.js](https://nodejs.org/en/download) version >= 6
 * [npm](https://github.com/npm/npm) or [yarn](https://yarnpkg.com/en/docs/install)
 
 ## installation
 
-Install the gtt command line interface:
+Install the gtt command line interface using yarn:
 
 ```
-# using yarn
 yarn global add gitlab-time-tracker --prefix /usr/local
+```
 
-# using npm
+... or using npm:
+
+```
 npm install -g gitlab-time-tracker
 ```
 
@@ -38,62 +42,111 @@ url: https://gitlab.com/api/v4/
 token: 01234567891011
 ```
 
+## updating
+
+Update gtt via yarn:
+
+```
+yarn global upgrade gitlab-time-tracker
+```
+
+... or npm:
+
+```
+npm install -g gitlab-time-tracker
+```
+
 ## commands
 
-#### time tracking
+### configuration
 
+> [Click here](#configuration-options) for a complete list of configuration options.
 
+**Edit/create the global configuration file, stored in your home directory:**
 
-Time tracking enables you to track and monitor your time locally. When you're done,
-you can sync time records to GitLab and create "time spent comments" automatically. 
+```
+gtt config
+```
+
+**Edit/create a local configuration file `.gtt.yml` in the current working directory:**
+
+```
+gtt config --local
+```
+
+If a local configuration file is present it's used instead of the global one.
+So you can use gtt on a per project basis. Make sure to add .gtt.yml to your 
+gitignore file if using a local configuration.
+
+### time tracking
+
+Time tracking enables you to monitor the time you spent on an issue or merge request locally.
+When you're done, you can sync these time records to GitLab: gtt adds the time spent to the given 
+issue or merge request and automagically keeps everything in sync with your local data.
+ 
+Did you forgot to stop time monitoring locally and accidentally synced it to GitLab? 
+No worries, just edit the local record and run sync again.
+
+**Start local time monitoring for the given project and id:**
 
 ```
-# start LOCAL time monitoring for the given project and id. if you 
-# configured a project in your config you can omit the project
 gtt start "kriskbx/example-project" 15
 gtt start 15
+```
 
-# status
+If you configured a project in your config you can omit the project.
+
+**Show the current time monitoring status:**
+
+```
 gtt status
+```
 
-# stop LOCAL time monitoring
+**Stop local time monitoring and save as a new time record:**
+
+```
 gtt stop
+```
 
-# cancel LOCAL time monitoring and discard the record
+**Cancel local time monitoring and discard the time record:**
+
+```
 gtt cancel
+```
 
-# log LOCAL time records
+**Show a list of all local time records (including their ids and meta data):**
+
+```
 gtt log
+```
 
-# edit a LOCAL time record by it's id. you can omit the id
-# to edit the last time record recorded
-gtt edit 2xZkV5LNM
+**Edit a local time record by the given id:**
+
+```
+gtt edit 2XZkV5LNM
 gtt edit
+```
 
-# delete a LOCAL time record by it's id. you can omit the id
-# to delete the last time record recorded
-gtt delete 2xZkV5LNM
-gtt delete
+You can omit the id to edit the last added time record.
+
+**Delete a local time record by the given id:**
 
-# sync LOCAL time records to GitLab and create "time spent comments"
-gtt sync
+```
+gtt delete 2XZkV5LNM
+gtt delete
 ```
 
-#### edit configuration
+You can omit the id to delete the last added time record.
 
-Edit the configuration file. [Available options](#options)
+**Sync local time records with time tracking data on Gitlab:**
 
 ```
-# edit/create the global configuration file, stored in your home directory
-gtt config
-
-# edit/create a local configuration file (.gtt.yml) in the current directory.
-# if a local configuration file is present, it's used instead of the global one.
-# so you can use gtt on a per project basis. make sure to add .gtt.yml to your 
-# gitignore file if using a local configuration
-gtt config --local
+gtt sync
+gtt sync --proxy="http://localhost:8888"
 ```
 
+You can pass an url to the proxy option if you want to use a proxy server.
+
 #### reports
 
 Get a report for your project from GitLab.