From d4a22d2ebe4ea85d41c5a1898984e3e277e4f8ee Mon Sep 17 00:00:00 2001
From: needForBeans <lucamrickli@gmail.com>
Date: Sat, 25 May 2024 21:41:44 +0200
Subject: [PATCH] docs

---
 astro-plugin/README.md | 70 +++++++++++++++++++++++++++++++++++++++++-
 github-oauth/README.md |  6 ++++
 2 files changed, 75 insertions(+), 1 deletion(-)

diff --git a/astro-plugin/README.md b/astro-plugin/README.md
index 7fb3659..055b8aa 100644
--- a/astro-plugin/README.md
+++ b/astro-plugin/README.md
@@ -1 +1,69 @@
-# Jamstack CMS astro plugin
+# Astro plugin
+
+![npm](https://img.shields.io/npm/v/%40lucarickli%2Fjamstack-cms-astro)
+![size](https://img.shields.io/bundlejs/size/%40lucarickli%2Fjamstack-cms-astro)
+
+Astro plugin to easily integrate jamstack-cms into your website.
+
+## Install
+
+```sh
+npm i --save @lucarickli/jamstack-cms-astro
+```
+
+**File** `astro.config.mjs`
+
+```js
+import { defineConfig } from "astro/config";
+import { jamstackCmsPlugin } from "@lucarickli/jamstack-cms-astro";
+import sitemap from "@astrojs/sitemap";
+
+export default defineConfig({
+  site: "https://example.com",
+  integrations: [
+    sitemap(),
+    jamstackCmsPlugin({
+      backend: {
+        ...
+      },
+      collections: [
+        ...
+      ],
+    }),
+  ],
+});
+```
+
+## Commands
+
+### Dev
+
+```sh
+npm run dev
+```
+
+### Dev + debug
+
+```sh
+npm run dev:debug
+```
+
+### Build
+
+```sh
+npm run build
+```
+
+### Start
+
+> This requires a build of the app!
+
+```sh
+npm run start
+```
+
+### Run checks
+
+```sh
+npm run check
+```
diff --git a/github-oauth/README.md b/github-oauth/README.md
index 10978a3..448d9dc 100644
--- a/github-oauth/README.md
+++ b/github-oauth/README.md
@@ -41,3 +41,9 @@ npm run build
 ```sh
 npm run start
 ```
+
+### Run checks
+
+```sh
+npm run check
+```