docs: optimize README for clarity and accuracy#12
Conversation
- Condense to ~150 lines (from ~400) — faster scan, less noise - Remove verbose tables; use inline code blocks with examples - Fix inaccuracies: remove non-existent `premium buy-credits` command - Add missing flags: limit-order --chain/--condition/--expiry, perps order -S/-s/-T/-p/-z/-r/-g/--tpsl, perps close -s/--symbol, discover trending -t - Add missing commands: receive perps --address - Group related commands logically (AI trading bots as section) - Update test count (270 tests)
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly refactors the README.md to provide a more concise and streamlined overview of the Minara CLI. It replaces verbose tables and lengthy descriptions with compact command examples and inline comments across all sections, including trading, AI chat, and configuration. Additionally, the development and security sections were simplified, and the test count was updated. Feedback suggests re-incorporating the npm run test:watch command into the development section to improve the developer experience for those running tests in watch mode.
| npm install | ||
|
|
||
| # Build | ||
| npm run build | ||
|
|
||
| # Watch mode | ||
| npm run dev | ||
|
|
||
| # Run locally | ||
| node dist/index.js --help | ||
|
|
||
| # Link globally for testing | ||
| npm link | ||
| minara --help | ||
| npm run build # Compile TypeScript | ||
| npm run dev # Watch mode | ||
| npm test # Run 270 tests | ||
| npm run test:coverage |
There was a problem hiding this comment.
The development section in the README is missing the npm run test:watch command which is available in the package.json scripts. Adding this provides a better developer experience for those who prefer watch mode during testing.
| npm install | |
| # Build | |
| npm run build | |
| # Watch mode | |
| npm run dev | |
| # Run locally | |
| node dist/index.js --help | |
| # Link globally for testing | |
| npm link | |
| minara --help | |
| npm run build # Compile TypeScript | |
| npm run dev # Watch mode | |
| npm test # Run 270 tests | |
| npm run test:coverage | |
| npm install | |
| npm run build # Compile TypeScript | |
| npm run dev # Watch mode | |
| npm test # Run 270 tests | |
| npm run test:watch # Watch mode | |
| npm run test:coverage |
1 participant
Summary
premium buy-creditscommand)Key Changes
Fixes
minara premium buy-credits(command doesn't exist in codebase)receive perps --addressflag--chain,--condition,--price,--amount,--expiry-S/--side,-s/--symbol,-T/--type,-p/--price,-z/--size,-r/--reduce-only,-g/--grouping,--tpslperps close -s/--symbolflagdiscover trending -tflagImprovements
Test plan
npx vitest run— all 270 tests pass