chore(docs) improve readme readability #3
Conversation
WalkthroughThe changes in this pull request focus on restructuring and reformatting the Changes
Possibly related PRs
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 (2)
README.md (2)
30-46: Fix formatting inconsistencies in client functions list.Several functions are missing spaces after their hyphens, and some have inconsistent spacing around the function names.
Apply these formatting fixes:
- `listorders` -Requests open orders from Mostro pubkey - `neworder` -Create a new buy/sell order on Mostro - `takesell` -Take a sell order from a Mostro pubkey - `takebuy ` -Take a buy order from a Mostro pubkey - `addinvoice` -Buyer add a new invoice to receive the payment - `getdm ` -Get the latest direct messages from Mostro - `fiatsent` -Send fiat sent message to confirm payment to other user - `release ` -Settle the hold invoice and pay to buyer + `listorders` - Requests open orders from Mostro pubkey + `neworder` - Create a new buy/sell order on Mostro + `takesell` - Take a sell order from a Mostro pubkey + `takebuy` - Take a buy order from a Mostro pubkey + `addinvoice` - Buyer add a new invoice to receive the payment + `getdm` - Get the latest direct messages from Mostro + `fiatsent` - Send fiat sent message to confirm payment to other user + `release` - Settle the hold invoice and pay to buyer🧰 Tools
🪛 Markdownlint
33-33: null
Spaces inside code span elements(MD038, no-space-in-code)
35-35: null
Spaces inside code span elements(MD038, no-space-in-code)
37-37: null
Spaces inside code span elements(MD038, no-space-in-code)
14-14: Fix markdown formatting issues.The markdown linter identified some formatting issues:
- Remove trailing colons from headings
- Remove extra spaces in code spans
Apply these changes:
- #### Core Functions: + #### Core Functions - #### Client Functions: + #### Client FunctionsAlso applies to: 28-28
🧰 Tools
🪛 Markdownlint
14-14: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md
14-14: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
28-28: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
33-33: null
Spaces inside code span elements
(MD038, no-space-in-code)
35-35: null
Spaces inside code span elements
(MD038, no-space-in-code)
37-37: null
Spaces inside code span elements
(MD038, no-space-in-code)
🔇 Additional comments (1)
README.md (1)
16-21: LGTM! Well-organized core functions section.
The core functions are clearly documented with consistent formatting and helpful descriptions.
|
|
||
| ### Mostro Core Implementation | ||
|
|
||
| Implementation of core functionality in TypeScript/JavaScript. See [mostro-core](https://github.com/MostroP2P/mostro-core). |
There was a problem hiding this comment.
Fix repository link and differentiate implementation descriptions.
The client implementation section has an incorrect repository link and uses the same description as the core implementation.
Apply these changes:
- Implementation of core functionality in TypeScript/JavaScript. See [mostro-core](https://github.com/MostroP2P/mostro-cli).
+ Implementation of client-side functionality in TypeScript/JavaScript. See [mostro-cli](https://github.com/MostroP2P/mostro-cli).Also applies to: 26-26
Summary by CodeRabbit