Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #191

Closed
wants to merge 3 commits into from
Closed

Update README.md #191

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b9150a
Update README.md
Aatmaj-Zephyr Oct 8, 2022
bfce3c3
Update README.md
justinegeffen Nov 18, 2022
7fa8d77
Merge branch 'master' into patch-1
mattermod Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your Todo message here>` 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 <your Todo message here>` 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 <username> <your Todo message here>` 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 <username> <your Todo message here>` 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.