README.md in nin-1.0.1 vs README.md in nin-1.2.0

- old
+ new

@@ -13,10 +13,11 @@ ## Features - Simple, intuitive, and easy-to-use CLI - Currently supports: listing, adding, editing, deleting, completing, archiving, prioritizing, and analyzing todo items +- Integration and synchronization with [Todoist](https://todoist.com/) (With potential integration with more platforms) - Smart colored output - Uses YAML for storage by default (There's the option to add other stores but no configuration for it, yet) - Modular code covered by unit tests ## Installation @@ -33,11 +34,11 @@ USAGE: nin COMMAND [arguments...] COMMANDS: - l | list [a] List all unarchived todos. Pass optional argument `a` to list all todos + l | list [a|l] List all unarchived todos. Pass optional argument `a` to list all todos or `l` to list local todos only a | add desc Add a todo. Prepend due date by a @. Prepend each tag by a \# e | edit id desc Edit a todo. Prepend due date by a @. Prepend each tag by a \# p | prioritize id step Prioritize a todo by either a positive or negative step within its date group c | complete id(s) Un/complete todo(s) ac | archive id(s) Un/archive todo(s) @@ -69,9 +70,17 @@ example, passing a 1 as as step prioritizes the item by one item up and passing -2 prioritizes the item by 2 items down - REPL (interactive) mode is where you can pass commands and arguments without the need to call `nin` every time and can be triggered by calling `nin i` or `nin repl` + +## Integration + +### Todoist + +For Todoist integration, two environment variables must be set: + - `NIN_INTEGRATION_CLIENT=todoist` + - `NIN_INTEGRATION_CLIENT_TOKEN=token`. Token can be found in your [integration settings page](https://todoist.com/prefs/integrations) ## Development - Install a recent version of `Ruby` and `Bundler` - Run `bundle install` to install the dependencies