diff --git a/README.md b/README.md index 13e9d71..26974fd 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,30 @@ $ npm install --global dewy $ dewy ``` -Set your API token first: +## Configuration -```bash -export TODOIST_API_TOKEN="your-token-here" +dewy uses a config file at `~/.config/dewy/config.json`: + +```json +{ + "apiToken": "your-todoist-api-token", + "homeFilter": "(today | overdue) & (assigned to: me | !assigned)" +} ``` +| Key | Type | Required | Description | +|-----|------|----------|-------------| +| `apiToken` | string | yes | Your Todoist API token | +| `homeFilter` | string | no | Custom Todoist filter to apply on the home view | + ## Commands -- `add ` - Add a new task +- `add ` - Add a new task via Todoist's QuickAdd - `done ` - Complete a task by its number - `refresh` - Reload tasks +- `project ` - View tasks in a project +- `today` - View today's tasks +- `home` - View the home filter - `quit` - Exit ## License