Add quick start docs

LucasPickering · Oct 24, 2023 · 1c778eb · 1c778eb
1 parent 9a6a9b3
commit 1c778eb
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,10 @@
 # Slumber
 
+- [Home Page](https://slumber.lucaspickering.me)
+- [Installation](https://slumber.lucaspickering.me/artifacts/)
+- [Docs](https://slumber.lucaspickering.me/book/)
+- [Changelog](https://slumber.lucaspickering.me/changelog/)
+
 Slumber is a TUI (terminal user interface) REST client. Define, execute, and share configurable HTTP requests.
 
 ## Example

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,3 +1,3 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+- [Quick Start](./quick_start.md)
diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md
diff --git a/docs/src/quick_start.md b/docs/src/quick_start.md
@@ -0,0 +1,22 @@
+# Quick Start
+
+## 1. Installation
+
+See [install instructions](/artifacts/)
+
+## 2. Create a Slumber collection file
+
+Create a file called `slumber.yml` and add the following contents:
+
+```yaml
+requests:
+  - id: get
+    method: GET
+    url: https://httpbin.org/get
+```
+
+## 3. Run Slumber
+
+```sh
+slumber
+```