Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gotlium committed Feb 16, 2016
1 parent 98c80c5 commit a707acb
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 10 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
[![PyPI](https://badge.fury.io/py/mattermost_bot.svg)](https://pypi.python.org/pypi/mattermost_bot)
[![Codacy](https://api.codacy.com/project/badge/grade/b06f3af1d8a04c6faa9a76a4ae3cb483)](https://www.codacy.com/app/gotlium/mattermost_bot)
[![Code Health](https://landscape.io/github/LPgenerator/mattermost_bot/master/landscape.svg?style=flat)](https://landscape.io/github/LPgenerator/mattermost_bot/master)
[![Python Support](https://img.shields.io/badge/python-2.7,3.5-blue.svg)](https://pypi.python.org/pypi/mattermost_bot/)
[![Downloads from PyPi](https://img.shields.io/pypi/dm/mattermost_bot.svg)](https://pypi.python.org/pypi/mattermost_bot/)
[![Python Support](https://img.shields.io/badge/python-2.7,3.5-blue.svg)](https://pypi.python.org/pypi/mattermost_bot/)
[![Mattermost](https://img.shields.io/badge/mattermost-1.4+-blue.svg)](http://www.mattermost.org)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://pypi.python.org/pypi/mattermost_bot/)

Documentation available at [Read the Docs](http://mattermost-bot.readthedocs.org/).
Expand All @@ -19,6 +20,7 @@ A chat bot for [Mattermost](http://www.mattermost.org).
* Messages can be handled concurrently
* Automatically reconnect to mattermost when connection is lost
* Python3 Support
* Mattermost >= 1.x

## Installation

Expand Down Expand Up @@ -69,7 +71,7 @@ Now you can talk to your bot in your mattermost client!



### Attachment Support
## Attachment Support

```python
from mattermost_bot.bot import respond_to
Expand Down
5 changes: 0 additions & 5 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ Contributing

If you wish to contribute, please add corresponding tests.

.. image:: https://api.travis-ci.org/LPgenerator/mattermost_bot.png?branch=master
:target: https://travis-ci.org/LPgenerator/mattermost_bot
.. image:: https://coveralls.io/repos/LPgenerator/mattermost_bot/badge.png?branch=master
:target: https://coveralls.io/r/gLPgenerator/mattermost_bot?branch=master

Running tests::

make test
Expand Down
4 changes: 2 additions & 2 deletions docs/dev_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Installation for development
$ pip install -r requirements.txt
$ pip install -r docs/requirements.txt
$ touch local_settings.py # configure your local settings
$ matterbot
$ matterbot # run bot
.. code-block:: python
>>> import mattermost_bot
>>> print mattermost_bot.get_version()
>>> print(mattermost_bot.get_version())
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Recommended way to install is via pip::
Check `mattermost_bot` version::

import mattermost_bot
print mattermost_bot.get_version()
print(mattermost_bot.get_version())

0 comments on commit a707acb

Please sign in to comment.