Add installation instructions

dtinth · Jul 17, 2019 · d6c7ec7 · d6c7ec7
1 parent 6740435
commit d6c7ec7
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -42,7 +42,52 @@ Turn TODO comments inside source code into GitHub issues and closes them when th
 
 ## Usage
 
-Stay tuned!
+### What you need
+
+- [**GitHub Actions Beta Access**](https://github.com/features/actions) \
+  [Sign up for the beta here](https://github.com/features/actions/signup/).
+  Note that this is per-user and per-organization.
+
+- **A running MongoDB instance** \
+  You can get a free instance on [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
+  The same MongoDB database can be used with multiple repositories.
+
+### Setting up
+
+1. Go to the [todo-actions GitHub Marketplace page](https://github.com/marketplace/actions/todo-actions) and click **“Use latest version.”** Select a repository to install.
+
+   > <img src="./docs/images/install1.png" width="362" alt="Screenshot" />
+
+2. This will bring you to the GitHub workflow editor. Click on **“create a new workflow.”**
+
+   > <img src="./docs/images/install2.png" width="596" alt="Screenshot" />
+
+3. Give the workflow a name, such as TODO.
+
+   > <img src="./docs/images/install3.png" width="720" alt="Screenshot" />
+
+4. You should see a new workflow with `todo-actions` action inside.
+   Click on **“Edit”**.
+
+   > <img src="./docs/images/install4.png" width="720" alt="Screenshot" />
+
+5. Check the **`GITHUB_TOKEN`** secret to allow the action to access your repository.
+   Also click on **“Create a new secret”** to set up MongoDB database.
+
+   > <img src="./docs/images/install5.png" width="426" alt="Screenshot" />
+
+6. Name the secret **`TODO_ACTIONS_MONGO_URL`** and put in the database connection string.
+   Click on **Add secret.**
+
+   > <img src="./docs/images/install6.png" width="426" alt="Screenshot" />
+
+7. You should now see the secrets configured.
+
+   > <img src="./docs/images/install7.png" width="720" alt="Screenshot" />
+
+8. Commit your changes. You should see the workflow running on GitHub under **Actions** tab.
+
+   > <img src="./docs/images/install8.png" width="720" alt="Screenshot" />
 
 ## Development
 

diff --git a/docs/images/install1.png b/docs/images/install1.png
diff --git a/docs/images/install2.png b/docs/images/install2.png
diff --git a/docs/images/install3.png b/docs/images/install3.png
diff --git a/docs/images/install4.png b/docs/images/install4.png
diff --git a/docs/images/install5.png b/docs/images/install5.png
diff --git a/docs/images/install6.png b/docs/images/install6.png
diff --git a/docs/images/install7.png b/docs/images/install7.png
diff --git a/docs/images/install8.png b/docs/images/install8.png
diff --git a/docs/images/pulse.5a7b29e8.png b/docs/images/pulse.5a7b29e8.png