README.md in tsks-0.0.8 vs README.md in tsks-0.0.9
- old
+ new
@@ -1,31 +1,31 @@
# tsks
-A stateful command line interface to help you handle your daily tsks (with
+[](https://travis-ci.com/luanrvmood/tsks)
+
+A stateful command line interface to help you handle your daily tsks (with
synchronisation and contexts!).
-[](https://travis-ci.com/luanrvmood/tsks)
-
## Features
-* Add tsks, check what is already done and list active or archived tsks
-* Synchronise your tsks and access them from all your terminals!
+- Add tsks, check what is already done and list active or archived tsks
+- 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
+- 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
```
## Usage
-After follow the step above you should be able to run `tsks` from your terminal.
+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` to setup stuffs
+_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
@@ -36,11 +36,11 @@
```sh
tsks add "Bootstraps my pet project environment" --context=Today
```
-### Marking tsks as done
+### Marking tsks as done
```sh
tsks done 2 # Where 2 is the tsk id
```
@@ -55,20 +55,21 @@
```sh
tsks list --context=Today
```
**Or tsks already done**
+
```sh
tsks list --done
```
-**Tip:** It's possible to combine the flags `--done` and `--context` when
+**Tip:** It's possible to combine the flags `--done` and `--context` when
listing.
### Synchronising your tsks
-As easy as running `tsks sync`. This command will fetch your tsks from the API,
-then filter what is not synchronised yet from local, then update both
+As easy as running `tsks sync`. This command will fetch your tsks from the API,
+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: