From d4c787c40d7cc5c00ee0985228609b03661959c6 Mon Sep 17 00:00:00 2001 From: Florian Strzelecki Date: Sat, 10 Jul 2021 12:32:33 +0200 Subject: [PATCH] meta: bump version 0.2.0 --- README.rst | 38 ++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8f9960f..1d0e98b 100644 --- a/README.rst +++ b/README.rst @@ -10,3 +10,41 @@ Sopel magic 8 ball plugin:: User: Better not tell you now. .8ball Will I live forever? User: Very doubtful. + +Install +======= + +The preferred way to install this plugin is through ``pip``:: + + $ pip install sopel-8ball + +Note that you may need to use ``pip3``, depending on your system and your +installation. + +Once this is done, you should configure and enable the plugin:: + + $ sopel-plugins configure 8ball + $ sopel-plugins enable 8ball + +And then, restart your bot: this, again, depends on your system and how you run +your bot. + +Magic 8 ball choices +==================== + +There are more than one style of choices you can select: + +* ``classic``: the classic version (10 yes, 5 maybe, 5 no) +* ``snarky``: this version is rude (5 yes, 5 maybe, 10 no) +* ``spooky``: use at your own risk (5 yes, 10 maybe, 5 no, 100% freaky) + +This can be configured with the Sopel configuration wizard:: + + $ sopel-plugins configure 8ball + +Or manually, by editing your configuration and adding this section:: + + [magic8ball] + choices = classic + +Replace ``classic`` (the default) by one of the value above. diff --git a/setup.cfg b/setup.cfg index 41ece99..6ae82e5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = sopel-8ball -version = 0.1.1 +version = 0.2.0 description = Magic 8 ball plugin for Sopel keywords = sopel plugin height-ball bot irc long_description = file: README.rst