diff --git a/README.md b/README.md index d2abb27..f0e8a77 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,32 @@ # Agents +Trade autonomously on Polymarket using AI Agents. + +## How to start? + +1) Clone this repo +2) Add your OpenAI key and wallet to `.env` +3) Run this repo as: + * command line `cli.py` + * cron job `jobs/scheduler.py` + * server (coming soon) + +`lib/trade.py` contains core business logic which: +- queries polymarket data using the clob sdk +- performs rag using langchain and openai +- applies custom prompts in `ai/llm/prompts.py` +- automatically executes trades from your wallet + +## Customization + +This tool is meant to be modular and extensible. + +Below are instructions to begin developing on the codebase. + +We welcome contributions and hope for this to be a community led project. + +# Development + Please see `CONTRIBUTING.md` for contributing guidlines. ## Local Development diff --git a/jobs/scheduler.py b/jobs/scheduler.py index ac74863..4c350ca 100644 --- a/jobs/scheduler.py +++ b/jobs/scheduler.py @@ -1,6 +1,6 @@ import datetime as dt import time -from polymarket.agents.jobs.trade import Trader +from polymarket.agents.lib.trade import Trader from polymarket.agents.lib.history import record_history from polymarket.agents.lib.refresh import refresh_trades diff --git a/jobs/trade.py b/lib/trade.py similarity index 100% rename from jobs/trade.py rename to lib/trade.py