add README

planetarium · Aug 23, 2024 · f072ca7 · f072ca7
1 parent 00a0a2e
commit f072ca7
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,14 @@
+# Quick start
+
+To get started quickly, follow these steps:
+
+In the project directory, install the dependencies by running:
+```bash
+pnpm install
+```
+Next, start the development server by running:
+```bash
+pnpm docs:dev
+```
+
+Finally, open your browser and navigate to `http://localhost:5174` to see the documentation site.