docs(readme): Update readme with information about the changelog command

README.md

@@ -22,13 +22,15 @@ Options:
   --minor  Force minor version.
   --patch  Force patch version.
   --noop   No-operations mode, finds the new version number without changing it.
+  --post   If used with the changelog command, the changelog will be posted to the release api.
   --help   Show this message and exit.
 ```
 
 ### Commands
 
 * `version` - Create a new release. Will change the version, commit it and tag it.
 * `publish` - Runs version before pushing to git and uploading to pypi.
+* `changelog` - Generates the changelog for the next release.
 
 ### Running commands from setup.py
 Add the following to your setup.py and you will be able to run `python setup.py <command>`

docs/readme.rst

@@ -1,6 +1,9 @@
 python-semantic-release |Build status| |Coverage status|
 ========================================================
 
+|semantic-release| |Join the chat at
+https://gitter.im/relekang/python-semantic-release| |PyPI version|
+
 Automatic semantic versioning for python projects. `This blogpost
 explains in more
 detail <http://rolflekang.com/python-semantic-release/>`__.
@@ -28,6 +31,7 @@ ignored. Running release can be run locally or from a CI service.
       --minor  Force minor version.
       --patch  Force patch version.
       --noop   No-operations mode, finds the new version number without changing it.
+      --post   If used with the changelog command, the changelog will be posted to the release api.
       --help   Show this message and exit.
 
 Commands
@@ -37,6 +41,7 @@ Commands
    it and tag it.
 -  ``publish`` - Runs version before pushing to git and uploading to
    pypi.
+-  ``changelog`` - Generates the changelog for the next release.
 
 Running commands from setup.py
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -56,30 +61,17 @@ Add the following to your setup.py and you will be able to run
 Configuration
 ~~~~~~~~~~~~~
 
-All configuration described here belongs in ``setup.cfg`` in a section:
-``semantic-release``.
-
-``version_variable`` - The filename and variable name of where the
-version number is stored, e.g.
-``semantic_release/__init__.py:__version__``. ``patch_without_tag`` - If
-set to true semantic-release will create a new release even if there is
-no tag in any commits since last release. Default: false.
-``check_build_status`` - If set to true the status of the head commit
-will be checked and a release will only be created if the status is
-success. Default: false.
-
-Tags
-^^^^
-
-There are a set of tags used to evaluate the changes from commit
-messages. They can be configured to meet what you want them to be. The
-different tags are listed below with their defaults.
-
--  **Major change:** ``major_tag = :boom:`` :boom:
--  **Minor change:** ``minor_tag = :sparkles:`` :sparkles:
--  **Patch change:** ``patch_tag = :bug:`` :bug:
+Configuration belong in ``semantic_release`` section of the setup.cfg
+file in your project. Details about configuration options can be found
+in `the configuration
+documentation <http://python-semantic-release.readthedocs.org/en/latest/configuration.html>`__.
 
 .. |Build status| image:: https://ci.frigg.io/relekang/python-semantic-release.svg
    :target: https://ci.frigg.io/relekang/python-semantic-release/last/
 .. |Coverage status| image:: https://ci.frigg.io/relekang/python-semantic-release/coverage.svg
    :target: https://ci.frigg.io/relekang/python-semantic-release/last/
+.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+   :target: https://semantic-release.org
+.. |Join the chat at https://gitter.im/relekang/python-semantic-release| image:: https://badges.gitter.im/Join%20Chat.svg
+   :target: https://gitter.im/relekang/python-semantic-release?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+.. |PyPI version| image:: https://badge.fury.io/py/python-semantic-release.svg