diff --git a/.github/preview.png b/.github/preview.png index 63bd742..b80900a 100644 Binary files a/.github/preview.png and b/.github/preview.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..9698c27 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +![sidebase website](./.github/preview.png) + +# sidebase docs + +The sidebase homepage (https://sidebase.io), including the documentation for the sidebase development kit. + +## Quick start + +1. Clone the repository + ```sh + git clone https://github.com/sidebase/docs + ``` +2. Install the dependencies + ```sh + pnpm install + ``` +3. Start developing (with [vitepress](https://vitepress.dev/)) at [localhost:5173](http://localhost:5173) + ```sh + pnpm dev + ``` + +## Contributing + +This repository only contains: + +- The sidebase.io homepage +- The sidebase development kit documentation +- Redirects from previous documentation to their respective new sites + +If you would like to edit the documentation to one of our modules, please visit their respective repositories + +- [@sidebase/nuxt-auth](https://github.com/sidebase/nuxt-auth)