Skip to content

Commit

Permalink
Moved README.md to README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
cganterh committed Mar 23, 2018
1 parent 0c5200e commit 2c5ec54
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 31 deletions.
29 changes: 0 additions & 29 deletions README.md

This file was deleted.

29 changes: 29 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Le
==

.. image:: https://raw.githubusercontent.com/cganterh/le/master/coverage.svg?sanitize=true

Le is a silly extensible chatbot. This package is designed to load plugins in the entry point
groups ``le.parsers``, ``le.handlers`` and ``le.handlers.chat``.

For more examples on how to write new plugins you can look at the ones I wrote:

* `lecluvindex <https://github.com/cganterh/lecluvindex>`_
* `lehello <https://github.com/cganterh/lehello>`_
* `lechat <https://github.com/cganterh/lechat>`_
* `lemaster <https://github.com/cganterh/lemaster>`_

You can install any of these packages together and the run ``lebot`` to start your bot::

lebot <telegram_token>

The usage of the command is::

usage: lebot [-h] [-d] telegram_token

positional arguments:
telegram_token

optional arguments:
-h, --help show this help message and exit
-d, --debug
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[metadata]
name = le
version = 1.0.2
version = 1.0.3
url = https://github.com/cganterh/le
author = Cristóbal Ganter
author_email = cganterh@gmail.com
description = A silly chatbot for telegram.
long_description = file: README.md
long_description = file: README.rst
keywords = python, python3, telegram-bot, chatbot
license = MIT
classifiers =
Expand Down

0 comments on commit 2c5ec54

Please sign in to comment.