initial docs

1 files changed, 30 insertions, 0 deletions

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..77144d5
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,30 @@
+# Astal Docs
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+This directory contains the Astal documentation website. Hosted at [aylur.github.io/astal](https://aylur.github.io/astal/)
+
+## Commands
+
+| Command           | Action                                      |
+| :---------------- | :------------------------------------------ |
+| `npm install`     | Installs dependencies                       |
+| `npm run dev`     | Starts local dev server at `localhost:4321` |
+| `npm run build`   | Build your production site to `./dist/`     |
+| `npm run preview` | Preview your build locally                  |
+
+## Add your creation to the landing page
+
+1. Add your image as a webp to `public/showcase`
+2. Add it to `src/content/showcases.ts`
+   - `src` should be `/astal/showcase/your-name-optional-title.webp`
+   - `url` should point to the source code of the showcased widget
+   - `author` your name
+
+```
+.
+├── public/showcase
+│   └── your-name-optional-title.webp   # 1. add image
+└── src/content/
+    └── showcases.ts                    # 2. add information
+```