change readme

This commit is contained in:
Alexander Bersenev
2019-08-21 02:03:55 +05:00
parent 04491f8a6a
commit 014e450e62

View File

@@ -1,17 +1,17 @@
# Async MTProto Proxy # # Async MTProto Proxy #
Fast and simple to setup mtproto proxy. Fast and simple to setup mtproto proxy written on Python.
## Starting Up ## ## Starting Up ##
1. `git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy` 1. `git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy`
2. *(optional, recommended)* edit *config.py*, set **PORT**, **USERS** and **AD_TAG** 2. *(optional, recommended)* edit *config.py*, set **PORT**, **USERS** and **AD_TAG**
3. `docker-compose up -d` (or just `python3 mtprotoproxy.py` if you don't like Docker) 3. `docker-compose up -d` (or just `python3 mtprotoproxy.py` if you don't like Docker)
4. *(optional, shows telegram link to set the proxy)* `docker-compose logs` 4. *(optional, get a link to share the proxy)* `docker-compose logs`
## Channel Advertising ## ## Channel Advertising ##
To advertise a channel get a tag from **@MTProxybot** and write it to *config.py*. To advertise a channel get a tag from **@MTProxybot** and put it to *config.py*.
## Performance ## ## Performance ##