diff --git a/README.md b/README.md deleted file mode 100644 index 4a1ff3c..0000000 --- a/README.md +++ /dev/null @@ -1,29 +0,0 @@ -Le -== - -![Coverage badge](coverage.svg) - -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 lechat to start your bot: - - lebot - -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 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ffdcc7b --- /dev/null +++ b/README.rst @@ -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 `_ +* `lehello `_ +* `lechat `_ +* `lemaster `_ + +You can install any of these packages together and the run ``lebot`` to start your bot:: + + lebot + +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 diff --git a/setup.cfg b/setup.cfg index 23e819f..bfd2710 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 =