From a8b3762baa5ad4303a6b2c34786bf8464fc7773a Mon Sep 17 00:00:00 2001 From: warproxxx Date: Mon, 3 Nov 2025 09:28:34 -0800 Subject: [PATCH] Update readme --- README.md | 54 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 35 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 426650b..6af680d 100644 --- a/README.md +++ b/README.md @@ -71,48 +71,64 @@ uv run python update_stats.py ### Setup Steps -1. **Clone the repository**: +#### 1. Clone the repository + ```bash git clone https://github.com/yourusername/poly-maker.git cd poly-maker ``` -2. **Install Python dependencies**: +#### 2. Install Python dependencies + ```bash uv sync ``` -3. **Install Node.js dependencies for the merger**: -``` +#### 3. Install Node.js dependencies for the merger + +```bash cd poly_merger npm install cd .. ``` -4. **Set up environment variables**: -``` +#### 4. Set up environment variables + +```bash cp .env.example .env ``` -5. **Configure your credentials in `.env`**: +#### 5. Configure your credentials in `.env` + +Edit the `.env` file with your credentials: - `PK`: Your private key for Polymarket - `BROWSER_ADDRESS`: Your wallet address -Make sure your wallet has done at least one trade thru the UI so that the permissions are proper. +**Important:** Make sure your wallet has done at least one trade through the UI so that the permissions are proper. -6. **Set up Google Sheets integration**: - - Create a Google Service Account and download credentials to the main directory - - Copy the [sample Google Sheet](https://docs.google.com/spreadsheets/d/1Kt6yGY7CZpB75cLJJAdWo7LSp9Oz7pjqfuVWwgtn7Ns/edit?gid=1884499063#gid=1884499063) - - Add your Google service account to the sheet with edit permissions - - Update `SPREADSHEET_URL` in your `.env` file +#### 6. Set up Google Sheets integration -7. **Update market data**: - - Run `uv run python update_markets.py` to fetch all available markets - - This should run continuously in the background (preferably on a different IP than your trading bot) - - Add markets you want to trade to the "Selected Markets" sheet. You'd wanna select markets from the "Volatility Markets" sheet. - - Configure corresponding parameters in the "Hyperparameters" sheet. Default parameters that worked well in November are there. +- Create a Google Service Account and download credentials to the main directory +- Copy the [sample Google Sheet](https://docs.google.com/spreadsheets/d/1Kt6yGY7CZpB75cLJJAdWo7LSp9Oz7pjqfuVWwgtn7Ns/edit?gid=1884499063#gid=1884499063) +- Add your Google service account to the sheet with edit permissions +- Update `SPREADSHEET_URL` in your `.env` file + +#### 7. Update market data + +Run the market data updater to fetch all available markets: + +```bash +uv run python update_markets.py +``` + +This should run continuously in the background (preferably on a different IP than your trading bot). + +- Add markets you want to trade to the "Selected Markets" sheet +- Select markets from the "Volatility Markets" sheet +- Configure parameters in the "Hyperparameters" sheet (default parameters that worked well in November are included) + +#### 8. Start the market making bot -8. **Start the market making bot**: ```bash uv run python main.py ```