Merge pull request #2 from mcinj/readme

readme update
This commit is contained in:
mcinj 2022-04-23 15:21:32 -04:00 committed by GitHub
commit 1f12a1ce32
Signed by: GitHub
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 11 deletions

2
.gitignore vendored
View file

@ -2,4 +2,4 @@ env/
*.ini *.ini
__pycache__/ __pycache__/
.idea .idea
config config/config.ini

View file

@ -8,23 +8,27 @@ The bot is specially designed for [SteamGifts.com](https://www.steamgifts.com/)
- Sleeps to restock the points. - Sleeps to restock the points.
- Can run 24/7. - 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 ### Run from sources
```bash ```bash
python -m venv env python -m venv env
source env/bin/activate source env/bin/activate
pip install -r requirements.txt pip install -r requirements.txt
python src/cli.py cd src
python run.py
``` ```
### Docker ### Docker
#### Run it #### Run it
```bash ```bash
# Run the container # Run the container
docker run --name steamgifts -d -it mcinj/docker-steamgifts-bot:latest docker run --name steamgifts -d -v /path/to/the/config/folder:/config mcinj/docker-steamgifts-bot:v2.0
# 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
``` ```
#### Or build it yourself locally #### 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 # Build the image
docker build -t steamgifts:latest . docker build -t steamgifts:latest .
# Run the container # Run the container
docker run --name steamgifts -d -it steamgifts:latest docker run --name steamgifts -d -v /path/to/the/config/folder:/config 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
``` ```

0
config/.gitkeep Normal file
View file