From 73d1198c19baafb0a678ec0b26148d0c03cb1518 Mon Sep 17 00:00:00 2001 From: Tom Casavant Date: Wed, 20 Jan 2021 13:36:06 -0500 Subject: [PATCH] Updated documentation for latest release --- README.md | 24 +++++++++++++++++++++--- maubot.yaml | 2 +- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d97b4c5..b9d4464 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/maubot.yaml b/maubot.yaml index bcaeb7b..0fde245 100644 --- a/maubot.yaml +++ b/maubot.yaml @@ -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.