mirror of
https://github.com/paul-nameless/tg
synced 2024-11-22 03:43:19 +00:00
Add usage instructions in README
This commit is contained in:
parent
cd9d17cf4f
commit
2cecac553b
1 changed files with 42 additions and 2 deletions
44
README.md
44
README.md
|
@ -1,3 +1,43 @@
|
|||
# Tg
|
||||
# tg
|
||||
|
||||
TUI client for telegram
|
||||
Console telegram client.
|
||||
|
||||
(!) currently it is in active development
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Clone repository.
|
||||
Run this command.
|
||||
|
||||
```
|
||||
docker run -i -t --rm \
|
||||
-v /tmp/docker-python-telegram/:/tmp/ \
|
||||
-e API_ID=[id]
|
||||
-e API_HASH=[hash]
|
||||
-e PHONE=[phone] \
|
||||
-e PYTHONPATH=/app -v $PWD:/app \
|
||||
akhmetov/python-telegram python3 /app/tg/main.py
|
||||
```
|
||||
|
||||
Where:
|
||||
|
||||
- `APP_ID` and `API_HASH` is keys from [telegram](https://core.telegram.org/api/obtaining_api_id)
|
||||
- `PHONE` your phone number (or login)
|
||||
|
||||
If you don't want to run it using docker, install `tdlib` and `python-telegram`
|
||||
|
||||
For example, macOS:
|
||||
|
||||
```
|
||||
brew install tdlib
|
||||
pip3 install python-telegram
|
||||
```
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
Usefull links to help develop this project.
|
||||
|
||||
- https://github.com/alexander-akhmetov/python-telegram
|
||||
- https://github.com/tdlib/td/tree/master/example#python
|
||||
|
|
Loading…
Reference in a new issue