diff --git a/README.md b/README.md index 33cccdfc..eb141b95 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# userbot -//To Do: Too lazy to create README now. +# Installing + +### The Easy Way + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) + +### The Normal Way + +Simply clone the repository and run the main file: +```sh +git clone https://github.com/Total-Noob-69/X-tra-Telegram +cd X-tra-Telegram +virtualenv -p /usr/bin/python3 venv +. ./venv/bin/activate +pip install -r requirements.txt +# +python3 -m startup +``` + +An example `config.py` file could be: + +**Not All of the variables are mandatory** + +__The UniBorg should work by setting only the first two variables__ + +```python3 +from sample_config import Config + +class Development(Config): + APP_ID = 6 + API_HASH = "eb06d4abfb49dc3eeb1aeb98ae0f581e" +``` + +## Mandatory Vars + +- Only two of the environment variables are mandatory. +- This is because of `telethon.errors.rpc_error_list.ApiIdPublishedFloodError` + - `APP_ID`: You can get this value from https://my.telegram.org + - `API_HASH`: You can get this value from https://my.telegram.org +- The userbot will not work without setting the mandatory vars.