chore(docs): initial description and roadmap #2
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
README.md (3)
1-4: Enhance the introduction section with more context and essential information.The introduction could be more comprehensive. Consider adding:
- A brief description of what Mostro is
- Installation instructions
- Basic usage examples
- Prerequisites or dependencies
- Links to related documentation
6-7: Improve the roadmap section header.Consider using proper markdown heading syntax and adding a brief description of the roadmap's purpose and timeline.
-Roadmap +# Roadmap + +This roadmap outlines the planned development of Mostro's core functionality and CLI tools.
19-38: Improve CLI methods documentation structure and formatting.The CLI methods section would benefit from:
- Proper markdown link formatting
- Consistent indentation
- Grouped commands by functionality
-Implement Mostro cli methods in TS/JS https://github.com/MostroP2P/mostro-cli +## CLI Implementation + +Implementation of CLI methods in TypeScript/JavaScript. See [mostro-cli](https://github.com/MostroP2P/mostro-cli). + +### Available Commands + +#### Order Management +- `listorders` - Requests open orders from Mostro pubkey +- `neworder` - Create a new buy/sell order +- `takesell` - Take a sell order +- `takebuy` - Take a buy order +- `cancel` - Cancel a pending order + +#### Payment Operations +- `addinvoice` - Buyer adds a new invoice to receive payment +- `fiatsent` - Confirm fiat payment to other user +- `release` - Settle the hold invoice and pay to buyer + +#### Communication +- `getdm` - Get the latest direct messages +- `rate` - Rate counterpart after trade completion + +#### Dispute Resolution +- `dispute` - Start a dispute + +#### Administrative Commands +- `admcancel` - Cancel an order (admin only) +- `admsettle` - Settle a seller's hold invoice (admin only) +- `admlistdisputes` - Request open disputes +- `admaddsolver` - Add a new dispute solver +- `admtakedispute` - Take a pending dispute + +#### Help +- `help` - Display command help information🧰 Tools
🪛 Markdownlint
19-19: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md
8-8: null
Bare URL used
(MD034, no-bare-urls)
19-19: null
Bare URL used
(MD034, no-bare-urls)
| Implement Mostro core in TS/JS https://github.com/MostroP2P/mostro-core | ||
|
|
||
| Functions: | ||
| dispute.ts | ||
| lib.ts | ||
| message.ts | ||
| order.ts | ||
| rating.ts | ||
| user.ts | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance the Mostro core implementation section.
The section needs better formatting and more detailed information:
- The URL should be properly formatted as a markdown link
- Each function should include a brief description of its purpose
-Implement Mostro core in TS/JS https://github.com/MostroP2P/mostro-core
+## Mostro Core Implementation
+
+Implementation of core functionality in TypeScript/JavaScript. See [mostro-core](https://github.com/MostroP2P/mostro-core).
+
+### Core Functions:
+
+- `dispute.ts` - Handles dispute resolution logic
+- `lib.ts` - Core library utilities
+- `message.ts` - Message handling functionality
+- `order.ts` - Order management system
+- `rating.ts` - User rating implementation
+- `user.ts` - User management functionality📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Implement Mostro core in TS/JS https://github.com/MostroP2P/mostro-core | |
| Functions: | |
| dispute.ts | |
| lib.ts | |
| message.ts | |
| order.ts | |
| rating.ts | |
| user.ts | |
| ## Mostro Core Implementation | |
| Implementation of core functionality in TypeScript/JavaScript. See [mostro-core](https://github.com/MostroP2P/mostro-core). | |
| ### Core Functions: | |
| - `dispute.ts` - Handles dispute resolution logic | |
| - `lib.ts` - Core library utilities | |
| - `message.ts` - Message handling functionality | |
| - `order.ts` - Order management system | |
| - `rating.ts` - User rating implementation | |
| - `user.ts` - User management functionality |
🧰 Tools
🪛 Markdownlint
8-8: null
Bare URL used
(MD034, no-bare-urls)
chore(structure): change package build to copy from nostr
Summary by CodeRabbit