diff --git a/README.md b/README.md index a5815d4f..b9c4fb78 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,33 @@ A plugin to track Todo issues in a list and send you daily reminders about your ## Install 1. Go the releases page and download the latest release. -2. On your Mattermost, go to System Console -> Plugin Management and upload it. +2. In Mattermost, go to **System Console > Plugin Management** and upload it. 3. Start using it! ## Usage +![image](https://user-images.githubusercontent.com/83284294/194702321-995ea864-c11e-400b-9129-0e9e16e65851.png) + + To add an issue to your Todo list, do one one of the following: -* Open the sidebar from the channel header and click the "Add new issue" button -* Type `/todo add ` into the textbox and send -* Click the on the dropdown menu from a post and click "Add Todo" +* Open the sidebar from the channel header and select **Add new issue**. +* Type `/todo add ` into the textbox and send. +* Select the dropdown menu from a post and click "Add Todo". To view your Todo list, do one of the following: -* Click on the button in the channel header to open the Todo list in the right sidebar. -* Type `/todo list` into the textbox and send +* Select the button in the channel header to open the Todo list in the right sidebar. +* Type `/todo list` into the textbox and send. To remove an issue from your list: -* Open the sidebar from the channel header and click the "Done" or "Won't Do" buttons below the issue you want to remove -* Type `/todo pop` into the text and send to remove the top issue in the list +* Open the sidebar from the channel header and select **Done** or **Won't Do** below the issue you want to remove. +* Type `/todo pop` into the text and send to remove the top issue in the list. To send an issue to another user: -* Open the sidebar from the channel header and click the "Add new issue" button and select the user you want to send the issue to -* Type `/todo send ` into the textbox and send +* Open the sidebar from the channel header and select **Add new issue**, the select the user you want to send the issue to. +* Type `/todo send ` into the textbox and send. -Every day you will get a reminder of the issues you need to complete from the `Todo` bot. The message is only sent if you have issues on your Todo list. +You'll get a daily reminder of the issues you need to complete from the `Todo` bot. The message is only sent if you have issues on your Todo list.