diff options
Diffstat (limited to 'Documentation.mdown')
| -rw-r--r-- | Documentation.mdown | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation.mdown b/Documentation.mdown new file mode 100644 index 0000000..2aad042 --- /dev/null +++ b/Documentation.mdown @@ -0,0 +1,40 @@ +## Things Plugin + +A plugin that lets you interact with the Things 3 database. + +### Features + +* Browse app sections: Inbox, Today, Upcoming, Someday, and Anytime +* Browse areas, projects, tags, and tasks. +* Drill down to navigate and find related items. +* Mark tasks and projects as completed. +* Create new tasks. + +### Enabling edit and create + +The task includes an action called "Set Things Authentication Key" that takes +in text. This is required to use the Things 3 URL API to create or edit tasks +and projects. + +To do this, go to your Things Settings > General, then turn on "Enable Things +URLs" and click on Manage to view the auth key. Copy it, then open quicksilver, +press `.` to enter text mode, paste the key and search for "Set Things +Authentication Key." + +Your key is stored in the keychain. + +### Syntax to create tasks + +The first line is interpreted as title. If you want to add notes, type `>>`. All +the text after that, including newlines will be interpreted as markdown notes +until it finds a "special line". + +Special lines are: + +* If the line starts with `#`, everything after that will be interpreted as a + comma-separated list of tags until end of line. +* If the line starts with `@`, everything after that will be interpreted as a + date until end of line. It supports natural language like "today", + "tomorrow", "in 3 days" or "next tuesday" and dates in the format yyyy-mm-dd. +* If the line starts with `!`, everything after that will be interpreted as a + deadline. Same rules as the date above. |