Skip to content

Commit

Permalink
meta: bump version 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Exirel committed Jul 10, 2021
1 parent 9bd2c01 commit d4c787c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
38 changes: 38 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,41 @@ Sopel magic 8 ball plugin::
<Sopel> User: Better not tell you now.
<User> .8ball Will I live forever?
<Sopel> 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.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit d4c787c

Please sign in to comment.