Skip to content

Commit

Permalink
cleaning up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexnicita committed Jul 31, 2024
1 parent 08f1394 commit 9cf5404
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion jobs/scheduler.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
File renamed without changes.

0 comments on commit 9cf5404

Please sign in to comment.