Skip to content

Rewrite README — make it actually readable#4

Merged
tennisleng merged 3 commits into
mainfrom
rewrite-readme
Apr 11, 2026
Merged

Rewrite README — make it actually readable#4
tennisleng merged 3 commits into
mainfrom
rewrite-readme

Conversation

@tennisleng

Copy link
Copy Markdown
Owner

The old README was a generic bullet-point template that looked AI-generated. This rewrites it from scratch to read like a real person explaining their project:

  • Explains what triangular arbitrage actually is and how the bot exploits it
  • Walks through key design decisions (maker fees, BNB discount, dynamic sizing, slippage estimation) and why they matter
  • Includes a full project structure map so someone can navigate the codebase
  • Adds a config table with real defaults and descriptions
  • Pulls in actual backtest numbers from backtest_results.json
  • Adds a what I learned section with honest reflection on the challenges
  • No emojis, no filler, no generic lists

@tennisleng tennisleng merged commit 499c44d into main Apr 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant