diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 00000000..c9b9962c Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/README.md b/README.md index 965b51e1..12c5999a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
- Logo + Logo

Portabase

@@ -22,21 +22,18 @@ Portabase is a tool designed to simplify the backup and restoration of your data [![Open Source](https://img.shields.io/badge/open%20source-❤️-red)](https://github.com/Portabase/portabase) -
- [![NextJS][NextJS]][NextJS-url] [![BetterAuth][BetterAuth]][BetterAuth-url] [![Drizzle][Drizzle]][Drizzle-url] [![ShadcnUI][ShadcnUI]][ShadcnUI-url] [![Docker][Docker]][Docker-url] -
-

- Documentation • + Website • + DocumentationDemo • - Installation • + InstallationReport BugRequest Feature @@ -47,6 +44,18 @@ Portabase is a tool designed to simplify the backup and restoration of your data

+## Installation + +You have 4 ways to install Portabase: + +- Automated CLI (recommended) - [details](https://portabase.io/docs/dashboard/setup#cli) +- Docker Compose setup - [details](https://portabase.io/docs/dashboard/setup#docker) +- Kubernetes with Helm (soon) +- Development setup - [details](https://portabase.io/docs/dashboard/setup#development) + +**Ensure Docker is installed on your machine before getting started.** + + ## Contributors