README.md in hbtrack-0.0.5 vs README.md in hbtrack-0.0.6
- old
+ new
@@ -1,6 +1,6 @@
-## Hbtrack
+# Hbtrack [](https://badge.fury.io/rb/hbtrack) [](https://travis-ci.org/kw7oe/hbtrack)
`hbtrack` is a simple command lines tool to keep track of your daily habits. The functionality of the current version is very limited.
## Installation
@@ -8,47 +8,41 @@
gem install hbtrack
```
## Usage
-#### Add a new habit
```
-$ hbtrack add habit_name
-```
-Duplicate habit name will be ignore.
+Usage: hbtrack <command> [<habit_name>] [options]
-#### Mark habit as done/undone
-```
-$ hbtrack done habit_name
-```
-This will mark the current habit as done for the current day.
+Commands:
+ add: Add habit(s)
+ remove: Remove habit(s)
+ list: List habit(s)
+ done: Mark habit(s) as done
+ undone: Mark habit(s) as undone
+Options:
+ -h, --help Show help messages of the command
```
-$ hbtrack undone habit_name
-```
-This will mark the current habit as undone for the current day.
-You can also mark your habit done/undone for the previous day by adding `-y` or `--yesterday` option:
-```
-$ hbtrack done/undone -y habit_name
-```
+**Note:** For more details about available options for each command, type `hbtrack <command> -h`
-#### Remove a habit
-```
-$ hbtrack remove habit_name
-```
+## Features
+- [x] List all habits
+ - with completion rate or total/done/undone count
+- [x] Add single or multiple habits at once
+- [x] Mark:
+ - single or mutiple habits as done/undone
+ - remaining habits of as done/undone
+ - habit(s) as done for specific day with `--day DAY`
+- [x] Remove single or multiple habits at once
+- [x] Generate report in HTML format. *(In Progress)*
-#### Listing Progress
+## Output
-You can list all your habits progress by:
+### List all habits:
```
-$ hbtrack list
-```
-This will list all the habits you added and its progress for the current month.
-
-**Output:**
-```
August 2017
-----------
1. workout : *** All: 3, Done: 3, Undone: 0
2. read : *** All: 3, Done: 3, Undone: 0
3. programming : *** All: 3, Done: 3, Undone: 0
@@ -60,30 +54,23 @@
All: 15, Done: 13, Undone: 2
```
**Note:** The actual output is colorized where green color font indicate done and red color font indicate undone.
-You can also look at the progress of an individual habit by:
+### List a habit:
```
-$ hbtrack list habit_name
-```
-
-**Output:**
-```
workout
-------
July 2017 : ******************************* All: 31, Done: 26, Undone: 5
August 2017 : *** All: 3, Done: 3, Undone: 0
```
+### List all habits with `-p`:
Extra options such as `-p` or `--percentage` can be provided to list the stats of your habits in terms of completion rate.
-```
-$ hbtrack list -p habit_name
-```
-With the extra options `-p`, the output will be:
+
```
August 2017
-----------
1. workout : *** Completion rate: 100.00%
2. read : *** Completion rate: 100.00%
@@ -116,10 +103,11 @@
The first line represent the name of the habit. The second rows onward represent the progress of the habit for each month. More details:
* `2017,6` represent your progress during June 2017.
* `1` is used to represent done.
* `0` is used to represent undone.
+* Black space is used to represent not recorded/dayoff.
* Each habit is seperated by a newline. For example:
```
workout
2017,7: 11111111111111111111
@@ -127,10 +115,10 @@
read
2017,7: 11111111111110011111
```
## Bugs/Features
-The project is still in development.
+The project is still under development.
If there are any bugs/features request, feel free to create a new issues.