Skip to content

docs: add project structure overview to README #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Galigar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add project structure overview to README #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,20 @@ Enjoy using the CLI application! If you encounter any issues, feel free to open

[Terms of Service](https://polymarket.com/tos) prohibit US persons and persons from certain other jurisdictions from trading on Polymarket (via UI & API and including agents developed by persons in restricted jurisdictions), although data and information is viewable globally.

## Project Structure

This overview helps you navigate the repository:

- **/agents**: Core logic for Polymarket AI agents.
- `polymarket/`: Clients for Gamma and CLOB APIs.
- `utils/`: Common utilities and data objects.
- **/docs**: Additional guides and documentation.
- **/scripts**: Useful scripts for interacting with the agents and APIs.
- **/tests**: Suite of tests to ensure code reliability.
- `Dockerfile`: Containerization setup for easy deployment.
- `.env.example`: Template for required environment variables.


<!-- LINKS -->
[contributors-shield]: https://img.shields.io/github/contributors/polymarket/agents?style=for-the-badge
[contributors-url]: https://github.com/polymarket/agents/graphs/contributors
Expand Down