Skip to content

Commit

Permalink
Improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cganterh committed Mar 23, 2018
1 parent 05e4b94 commit 0c5200e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,27 @@ Le

![Coverage badge](coverage.svg)

Le is a silly chatbot.
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 <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
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = le
version = 1.0.1
version = 1.0.2
url = https://github.com/cganterh/le
author = Cristóbal Ganter
author_email = cganterh@gmail.com
Expand Down

0 comments on commit 0c5200e

Please sign in to comment.