From 62fa8fd0c58c0c33e9a88b708ef8f6bb7350714a Mon Sep 17 00:00:00 2001
From: Tim Wallace <timwallacedev@gmail.com>
Date: Mon, 11 Nov 2024 17:06:14 -0500
Subject: [PATCH] update readme

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/README.md b/README.md
index 48becd5..5c19bb3 100644
--- a/README.md
+++ b/README.md
@@ -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
+
+1. Clone the repository:
+```bash
+git clone https://github.com/idrinth-api-bench/cli
+```
+
+2. Navigate to the directory:
+```bash
+cd  cli
+```
+
+3. Install the dependencies:
+```bash
+npm install
+```
+
+4. Generate language files:
+```bash
+npm run language
+```
+
+5. Create a new benchmark project: 
+```bash
+npx iabc
+```
+
+### Adding routes to new benchmark project
+
+1. Go into the newly created project and create a new file at src/routes/main/first-test.ts. Fill it with the following example content:
+```typescript
+export default () => ({
+    id: 'example test case',
+    main: {
+      method: 'get',
+      url: 'https://reqres.in/api/users',
+    },
+    pre: [
+      '^user-agent',
+    ],
+    post: [
+      '^status-2xx',
+    ],
+  });
+```
+
+2. Run the benchmark:
+```bash
+cd benchmark
+npm start
+```
+
+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. 
+```bash
+npx iab bench --threads=4 --repetitions=25
+```
+
 Please have a look at the [website](https://idrinth-api-ben.ch) for more
 information.