From 51fb1370ae2cb91a5db95c30c48aa087e4af88cf Mon Sep 17 00:00:00 2001 From: mcinj <98779161+mcinj@users.noreply.github.com> Date: Sat, 23 Apr 2022 15:20:09 -0400 Subject: [PATCH] readme update --- .gitignore | 2 +- README.md | 21 +++++++++++---------- config/.gitkeep | 0 {src => config}/config.ini.example | 0 4 files changed, 12 insertions(+), 11 deletions(-) create mode 100644 config/.gitkeep rename {src => config}/config.ini.example (100%) diff --git a/.gitignore b/.gitignore index 8e5348c..b77d53b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,4 @@ env/ *.ini __pycache__/ .idea -config \ No newline at end of file +config/config.ini \ No newline at end of file diff --git a/README.md b/README.md index ebb1d6c..d588329 100644 --- a/README.md +++ b/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 ``` diff --git a/config/.gitkeep b/config/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/config.ini.example b/config/config.ini.example similarity index 100% rename from src/config.ini.example rename to config/config.ini.example