Skip to content

Commit

Permalink
added readme and updated preview image
Browse files Browse the repository at this point in the history
  • Loading branch information
zoey-kaiser committed Jul 11, 2024
1 parent 63f3dda commit d091c6f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
Binary file modified .github/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit d091c6f

Please sign in to comment.