kate
/
uniborg
forked from uniborg/uniborg
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of https://github.com/udf/uniborg

This commit is contained in:
udf 2018-11-13 22:41:33 +02:00
parent dfa87dc849 c43114264f
commit 24f5b88d3a
Signed by: kate
GPG Key ID: E40724BAD73AF77B
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -8,7 +8,7 @@ Pluggable [``asyncio``](https://docs.python.org/3/library/asyncio.html)
Simply clone the repository and run the main file:
```sh
git clone https://github.com/uniborg/uniborg.git
git clone https://github.com/udf/uniborg.git
cd uniborg
python stdborg.py
```
@ -16,11 +16,11 @@ python stdborg.py
## design
The modular design of the project enhances your Telegram experience
through [plugins](https://github.com/uniborg/uniborg/tree/master/stdplugins)
through [plugins](https://github.com/udf/uniborg/tree/master/stdplugins)
which you can enable or disable on demand.
Each plugin gets the `borg`, `logger` and `storage` magical
[variables](https://github.com/uniborg/uniborg/blob/4805f2f6de7d734c341bb978318f44323ad525f1/uniborg/uniborg.py#L66-L68)
[variables](https://github.com/udf/uniborg/blob/4805f2f6de7d734c341bb978318f44323ad525f1/uniborg/uniborg.py#L66-L68)
to ease their use. Thus creating a plugin as easy as adding
a new file under the plugin directory to do the job:
@ -36,12 +36,12 @@ async def handler(event):
## internals
The core features offered by the custom `TelegramClient` live under the
[`uniborg/`](https://github.com/uniborg/uniborg/tree/master/uniborg)
[`uniborg/`](https://github.com/udf/uniborg/tree/master/uniborg)
directory, with some utilities, enhancements and the core plugin.
## learning
Check out the already-mentioned
[plugins](https://github.com/uniborg/uniborg/tree/master/stdplugins)
[plugins](https://github.com/udf/uniborg/tree/master/stdplugins)
directory to learn how to write your own, and consider reading
[Telethon's documentation](http://telethon.readthedocs.io/).