readme update
This commit is contained in:
parent
c41c21116d
commit
51fb1370ae
4 changed files with 12 additions and 11 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -2,4 +2,4 @@ env/
|
|||
*.ini
|
||||
__pycache__/
|
||||
.idea
|
||||
config
|
||||
config/config.ini
|
21
README.md
21
README.md
|
@ -8,23 +8,27 @@ The bot is specially designed for [SteamGifts.com](https://www.steamgifts.com/)
|
|||
- Sleeps to restock the points.
|
||||
- Can run 24/7.
|
||||
|
||||
|
||||
## Instructions
|
||||
1. Rename `config/config.ini.example` to `config/config.ini`.
|
||||
2. Add your PHPSESSION cookie to it.
|
||||
3. Modifying the other settings is optional.
|
||||
|
||||
### Run from sources
|
||||
|
||||
```bash
|
||||
python -m venv env
|
||||
source env/bin/activate
|
||||
pip install -r requirements.txt
|
||||
python src/cli.py
|
||||
cd src
|
||||
python run.py
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
#### Run it
|
||||
```bash
|
||||
# Run the container
|
||||
docker run --name steamgifts -d -it mcinj/docker-steamgifts-bot:latest
|
||||
# Attach to it to fill in the questions
|
||||
docker attach steamgifts # to detach, you must use ctrl+p then ctrl+q.
|
||||
# ctrl+c will kill the container
|
||||
docker run --name steamgifts -d -v /path/to/the/config/folder:/config mcinj/docker-steamgifts-bot:v2.0
|
||||
```
|
||||
|
||||
#### Or build it yourself locally
|
||||
|
@ -32,10 +36,7 @@ docker attach steamgifts # to detach, you must use ctrl+p then ctrl+q.
|
|||
# Build the image
|
||||
docker build -t steamgifts:latest .
|
||||
# Run the container
|
||||
docker run --name steamgifts -d -it steamgifts:latest
|
||||
# Attach to it to fill in the questions
|
||||
docker attach steamgifts # to detach, you must use ctrl+p then ctrl+q.
|
||||
# ctrl+c will kill the container
|
||||
docker run --name steamgifts -d -v /path/to/the/config/folder:/config steamgifts:latest
|
||||
```
|
||||
|
||||
|
||||
|
|
0
config/.gitkeep
Normal file
0
config/.gitkeep
Normal file
Loading…
Reference in a new issue