Merge pull request #191 from readthedocs/humitos/docs-improves

Author: humitos

README.rst

@@ -31,7 +31,7 @@ Or, alternatively, install it from GitHub directly (requires git):
 
 ::
 
-   pip install git+https://github.com/readthedocs/sphinx-hoverxref@master
+   pip install git+https://github.com/readthedocs/sphinx-hoverxref
 
 
 Configuration

docs/releasing.rst

@@ -9,9 +9,13 @@ These are the steps needed to release a new version:
      $ pip install flit bumpver
 
 #. Update the ``CHANGELOG.rst`` with the changes included in this release
+#. Add ``CHANGELOG.rst`` to git stage::
+
+     $ git add CHANGELOG.rst
+
 #. Increase version (``--patch``, ``--minor`` or ``--major``)::
 
-     $ bumpver update --minor
+     $ bumpver update --minor --allow-dirty
 
 #. Build the package and check everything is correct::