Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Commit

Permalink
Updated documentation for latest release
Browse files Browse the repository at this point in the history
  • Loading branch information
TomCasavant committed Jan 20, 2021
1 parent 21340a4 commit 73d1198
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,35 @@ A plugin for [maubot](https://github.com/maubot/maubot) that creates a poll in a
## Usage
'!poll new "Question" "Choice1" "Choice2" "Choice3"' - Creates a new poll with given (at least 1) choices

The user can now also create polls with line-breaks:
```
!poll new What is my question?
Choice1
Choice2
Choice3
```

'!poll results' - Displays the results from the poll

'!poll close' - Ends the poll

Users vote by adding the matching emoji to the poll (i.e. if the first choice has a :thumbsup: then in order to pick that choice the user has to react with :thumbsup:)

## Version 2.0
## Version 3.0 (Latest release)
- Made emoji options more accessible
- Bot now reacts to itself with emoji options
- The user can now define emoji options
- User can define answers with line-breaks rather than quotes


## Older Releases:

### Version 2.0
- Changed voting format to reactions (instead of '!poll vote')

### Version 2.0.1
- Allows every room to have unique poll
#### Version 2.0.1
- Allows every room to have unique poll


## Wish List
- Add user configuration to only allow certain users to create polls
Expand Down
2 changes: 1 addition & 1 deletion maubot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ maubot: 0.1.0
id: casavant.tom.poll

# A PEP 440 compliant version string.
version: 2.0.2
version: 3.0.0

# The SPDX license identifier for the plugin. https://spdx.org/licenses/
# Optional, assumes all rights reserved if omitted.
Expand Down

0 comments on commit 73d1198

Please sign in to comment.