Update README.md #123
Update README.md #123
Conversation
WalkthroughThe pull request updates the 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: 0
🧹 Outside diff range and nitpick comments (4)
README.md (4)
27-50: Improve setup instructions clarity and formattingThe setup instructions need some refinements:
- The repository URL might confuse users - they likely need to create their own project rather than clone the CLI repository
- The
npm run languagestep needs more context about what it does- The markdown formatting needs improvement for better readability
Consider this revised structure:
### Creating a new benchmark project 1. Create a new directory for your project: ```bash mkdir my-benchmark-project cd my-benchmark-project
Initialize the project:
npm init -yInstall the CLI tool:
npm install @idrinth-api-bench/cliGenerate a new benchmark project:
npx iabc<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary> 47-47: Expected: 0 or 2; Actual: 1 Trailing spaces (MD009, no-trailing-spaces) --- 32-32: Expected: 1; Actual: 2; Style: 1/1/1 Ordered list item prefix (MD029, ol-prefix) --- 37-37: Expected: 1; Actual: 3; Style: 1/1/1 Ordered list item prefix (MD029, ol-prefix) --- 42-42: Expected: 1; Actual: 4; Style: 1/1/1 Ordered list item prefix (MD029, ol-prefix) --- 47-47: Expected: 1; Actual: 5; Style: 1/1/1 Ordered list item prefix (MD029, ol-prefix) --- 28-28: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 33-33: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 38-38: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 43-43: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 48-48: null Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) --- 27-27: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 32-32: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 37-37: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 42-42: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) --- 47-47: null Lists should be surrounded by blank lines (MD032, blanks-around-lists) </details> </details> --- `54-69`: **Enhance route configuration documentation** The example would be more helpful with additional context explaining: - The purpose and requirements of each configuration property - Available options for pre/post conditions - What this specific example is testing (ReqRes API user endpoint) Consider adding explanatory comments: ```diff 1. Create a new file at src/routes/main/first-test.ts with the following content: ```typescript export default () => ({ // Unique identifier for this test case id: 'example test case', // Main request configuration main: { method: 'get', url: 'https://reqres.in/api/users', }, // Pre-request validations pre: [ '^user-agent', // Ensures proper user agent is set ], // Post-request validations post: [ '^status-2xx', // Ensures response status is in 2xx range ], }); ```🧰 Tools
🪛 Markdownlint
55-55: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
54-54: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
71-80: Improve benchmark execution instructionsThe instructions contain some grammatical issues and could be clearer:
Apply these improvements:
-3. Please don't try to create a service denial scenario and keep the thread count low. Creating a service denial scenario could result in the machine or network resource to become unavailable to intended users. You can use flags to modify the threads and repetitions. The total amount of requests will be threads X repetitions. Eg. 4 threads X 25 repetitions = 100 requests total. +3. Important: Keep the thread count low to avoid creating denial of service scenarios that could make services unavailable to other users. You can use flags to modify the number of threads and repetitions. The total number of requests will be threads × repetitions (e.g., 4 threads × 25 repetitions = 100 requests total).🧰 Tools
🪛 LanguageTool
[uncategorized] ~77-~77: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... the threads and repetitions. The total amount of requests will be threads X repetitio...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~77-~77: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...requests will be threads X repetitions. Eg. 4 threads X 25 repetitions = 100 reques...(E_G)
🪛 Markdownlint
77-77: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
71-71: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
77-77: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
72-72: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
78-78: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
71-71: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
77-77: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
25-81: Fix markdown formatting issuesThe document has several formatting inconsistencies that should be addressed:
- Add blank lines around lists and code blocks
- Use consistent list numbering style
- Ensure proper spacing throughout the document
Would you like me to provide a fully formatted version of the document that addresses all these issues?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~77-~77: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... the threads and repetitions. The total amount of requests will be threads X repetitio...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~77-~77: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...requests will be threads X repetitions. Eg. 4 threads X 25 repetitions = 100 reques...(E_G)
🪛 Markdownlint
47-47: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
77-77: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
32-32: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
37-37: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
42-42: Expected: 1; Actual: 4; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
47-47: Expected: 1; Actual: 5; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
71-71: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
77-77: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix(MD029, ol-prefix)
28-28: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
33-33: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
38-38: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
43-43: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
48-48: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
55-55: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
72-72: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
78-78: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
27-27: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
32-32: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
37-37: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
42-42: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
47-47: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
54-54: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
71-71: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
77-77: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~77-~77: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... the threads and repetitions. The total amount of requests will be threads X repetitio...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~77-~77: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...requests will be threads X repetitions. Eg. 4 threads X 25 repetitions = 100 reques...
(E_G)
🪛 Markdownlint
README.md
47-47: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
77-77: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
32-32: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
37-37: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
42-42: Expected: 1; Actual: 4; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
47-47: Expected: 1; Actual: 5; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
71-71: Expected: 1; Actual: 2; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
77-77: Expected: 1; Actual: 3; Style: 1/1/1
Ordered list item prefix
(MD029, ol-prefix)
28-28: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
33-33: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
38-38: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
43-43: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
48-48: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
55-55: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
72-72: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
78-78: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
27-27: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
32-32: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
37-37: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
42-42: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
47-47: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
54-54: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
71-71: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
77-77: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
| @@ -22,6 +22,63 @@ This project provides a CLI tool for @idrinth-api-bench/framework to generate co | |||
|
|
|||
| ## Usage & Examples | |||
|
|
|||
| ### Creating a new benchmark project | |||
There was a problem hiding this comment.
this is the cli, you added the description of the framework. The cli is there to generate routes and folder structures, usually you will not need to clone it at all.
The Pull Request is ready
Overview
Updated the README.md to add instructions for getting started and creating a benchmark project.
CLI
Summary by CodeRabbit
README.mdwith new sections for creating and managing benchmark projects using the CLI tool.