From 0eb171df9b67939fd3371188d894710748626021 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sun, 19 Jan 2020 21:38:53 +0000 Subject: [PATCH] Add details to readme --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1f9ed4b..031b7dc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,27 @@ -# todoist-github +# Todoist GitHub ![](https://github.com/RealOrangeOne/todoist-github/workflows/Build/badge.svg) -Import assigned issues and PRs into Todoist +Import assigned issues and PRs into Todoist. + +A docker container is available for easy usage: https://hub.docker.com/r/theorangeone/todoist-github + +## Requirements + +- `requirements.txt` installed in your environment +- `$TODOIST_TOKEN` +- `$GITHUB_TOKEN` (Requires at least `public_repo`, `repo` required for access to private repositories) + +## Usage + +Run `python3 -m todoist_github` to run once. `--interval` can be used to provide the number of seconds between automated updates. + +## Task Details + +Task names are built using the task link and title, and are updated automatically on rename. + +Tasks are added to projects based on the repository organisation / owner or repository name. If specially named projects exist as children of these, they're used instead. If no project is found, `$DEFAULT_TODOIST_PROJECT_NAME` can be used, else no project is assigned. + +Task due dates are based off their milestone. + +Once an issue is closed / PR merged, the task is completed. If you're unassigned, the issue is deleted.