docs: update documentation and add examples

eynopv · Jun 19, 2024 · 08d7223 · 08d7223
1 parent 16c523d
commit 08d7223
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,3 @@
 .env.*
 
 lac
-example/
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 `lac` is a cli only API client. It can be used for API exploration and testing.
 
-![screenshot of lac](docs/images/cli.png)
+![screenshot of lac](docs/images/carbon.png)
 
 ## Installation
 
@@ -15,10 +15,30 @@ go install github.com/eynopv/lac@latest
 ## Usage
 
 ```sh
-lac [command]
+lac [flags] request.json
 ```
 
-Read [manual](docs/Manual.md)
+### Example
+
+**Create request object**
+
+```js
+// get.json
+
+{
+  "path": "https://httpbin.org/get"
+}
+```
+
+**Send the request**
+
+```sh
+$ lac get.json
+```
+
+### Guide
+
+Read [user guide](docs/UserGuide.md)
 
 ## License
 

diff --git a/docs/Manual.md → docs/UserGuide.md b/docs/Manual.md → docs/UserGuide.md
diff --git a/docs/images/carbon.png b/docs/images/carbon.png
diff --git a/docs/images/cli.png b/docs/images/cli.png
diff --git a/examples/get.json b/examples/get.json
@@ -0,0 +1,4 @@
+{
+  "path": "${host}/get",
+  "method": "GET"
+}
diff --git a/examples/post.json b/examples/post.json
@@ -0,0 +1,10 @@
+{
+  "path": "${host}/post",
+  "method": "POST",
+  "headers": {
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "key": "value"
+  }
+}
diff --git a/examples/variables.json b/examples/variables.json
@@ -0,0 +1,3 @@
+{
+  "host": "https://httpbin.org"
+}