Update README.md

Author: doannc2212

.gitignore

@@ -1,2 +1,5 @@
 node_modules
 bun.lockb
+.obsidian
+.vscode
+.idea

README.md

@@ -1,9 +1,65 @@
+An application for create custom response.
+
+## Installation
+Firstly, clone this repository
+```
+git clone https://github.com/doannc2212/stub.git
 ```
+1. Run with bun
+```
+cd stub
 bun install
 bun run dev
 ```
-
+2. Docker (todo)
+```
+docker compose up -d
+```
+Then,
 ```
 open http://localhost:3000
 ```
-# stub
+
+## How to use?
+Note that you must attack cookie `userId=${value}` for api to know which user need mock response
+
+1. Create a new mock response
+Send a request to stub endpoint
+```json
+POST baseUrl/create
+Cookie: userId=john
+{
+	// request method
+	"method": "GET",
+	// requset path, which place right after baseUrl/api/
+	"path": "/sample",
+	// response body
+	"data": {
+		"id": 1,
+		"name": "John Doe"
+	},
+	// response status
+	"status": 200
+}
+```
+
+2. Clear mock response
+```json
+POST baseUrl/clear
+Cookie: userId=john
+```
+
+3. Retrieve mock data
+Send request to `baseUrl/api/` + `path` which you create before
+*Request*:
+```JSON
+GET baseUrl/api/sample
+Cookie: userId=john
+```
+Response:
+```JSON
+{
+	"id": 1,
+	"name": "John Doe"
+}
+```