README.md in tsks-0.0.2 vs README.md in tsks-0.0.3
- old
+ new
@@ -1,16 +1,19 @@
-# tsks-cli
+# tsks
-_A stateful command line interface to help you handle your daily tsks
-(with contexts!)._
+A stateful command line interface to help you handle your daily tsks (with
+synchronisation and contexts!).
+[![build](https://travis-ci.com/luanrvmood/tsks.svg?branch=master)](https://travis-ci.com/luanrvmood/tsks)
+
## Features
* Add tsks, check what is already done and list active or archived tsks
-* Synchronize your tsks and access them from all your terminals!)
-* Increase your daily tsks management with contexts `tsks add tsk --context=today`
- (see `tsks help add` for more info!)
+* Synchronise your tsks and access them from all your terminals!
+ (soon accessible from a webapp as well)
+* Increase your daily tsks management with contexts using
+ `tsks add tsk --context=today` (see `tsks help add` for more info)
## Installation
```ruby
gem install tsks
@@ -18,29 +21,29 @@
## Usage
After follow the step above you should be able to run `tsks` from your terminal.
-_It's important to notice that you will need to run `tsks init` before any other
-command to setup stuffs like the storage._
+_It's important to notice that you will need to run `tsks init` to setup stuffs
+like the storage before any other command._
### Adding new tsks
```sh
tsks add "My first tsk"
```
**Adding with context**
```sh
-tsks add "Bootstraps my pet project environment --context=Personal"
+tsks add "Bootstraps my pet project environment" --context=Today
```
-### Checking done tsks
+### Marking tsks as done
```sh
-tsks done 2 # Where 2 is the id
+tsks done 2 # Where 2 is the tsk id
```
### Listing your tsks
```sh
@@ -48,26 +51,26 @@
```
**Filtering by context**
```sh
-tsks list --context=Personal
+tsks list --context=Today
```
**Or tsks already done**
```sh
tsks list --done
```
**Tip:** It's possible to combine the flags `--done` and `--context` when
listing.
-### Synchronizing your tsks
+### Synchronising your tsks
As easy as running `tsks sync`. This command will fetch your tsks from the API,
-then filter what is not synced yet from local, and then update both remote and
-local tsks with most recent data.
+then filter what is not synchronised yet from local, then update both
+remote and local tsks with most recent data.
#### To be able to sync you will need to login or register an account
Run this to login:
@@ -85,10 +88,12 @@
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake spec` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`.
+To install this gem onto your local machine, run `bundle exec rake install`
+(This command installs the current tsks version **v0.0.2** in your machine
+path).
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/luanrvmood/tsks-cli.