meta: version 0.1.0

sopel-irc · Apr 12, 2020 · 9d9ee09 · 9d9ee09
1 parent 3810d20
commit 9d9ee09
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -1,3 +1,4 @@
+==========
 sopel-help
 ==========
 
@@ -6,3 +7,24 @@ Sopel plugin ``.help`` command::
     [Exirel]: .help help
     [Sopel]: Generate help for Sopel's commands.
     [Sopel]: e.g. .help help or .help
+
+Install
+=======
+
+The recommanded way to install this plugin is to use ``pip``::
+
+    $ pip install sopel-help
+
+Note that this plugin requires Python 3.5+ and Sopel 7+.
+
+Providers
+=========
+
+There are several providers built-in with this plugin:
+
+* ``base`` (the default): basic provider; it outputs help directly to the user
+* ``local``: it generates an HTML file and outputs an URL; you have to
+  install and configure your own origin server to serve that file
+* ``clbin``, ``0x0``, ``hastebin``, ``termbin``, ``ubuntu``: all these
+  providers post a plain-text file to a pastebin service and then output the
+  resulting URL
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = sopel-help
-version = 0.0.1-dev
+version = 0.1.0
 description = Help plugin for Sopel
 long_description = file: README.rst
 long_description_content_type = text/x-rst