docs: rewrite documentation

README.md

@@ -1,19 +1,31 @@
-<div align="center">
+<p align="center">
-    <h1 align="center">Omnidash</h1>
+    <a href="https://omnidash.io" target="_blank" rel="noopener">
-    <h5>Open Source Multi-client Ticket Dashboard</h5>
+        <img src="/static/github.png" alt="Omnidash - Keep your operation teams sane" />
-</div>
+    </a>
+</p>
 
 <div align="center">
   <a href="https://sonarcloud.io/api/project_badges/measure?project=bartvdbraak_omnidash&metric=alert_status"><img src="https://sonarcloud.io/api/project_badges/measure?project=bartvdbraak_omnidash&metric=alert_status" /></a>
+  <a href="https://omnidash-unlighthouse.pages.dev"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/bartvdbraak/b948b29508e19955106a1037d2a615e6/raw/omnidash.io-unlighthouse.json" /></a>
   <a href="https://github.com/bartvdbraak/omnidash/deployments/activity_log?environment=Production"><img src="https://img.shields.io/github/deployments/bartvdbraak/omnidash/production?label=vercel&logo=vercel" /></a>
 </div>
 
-<div align="center">
+[Omnidash](https://omnidash.io) is an open source ticket sourcing system, consisting of:
-  <a href="https://omnidash.io?ref=github">omnidash.io</a>
-</div>
-<br/>
 
-## Installation
+- [PocketBase](https://pocketbase.io) for ease of extensibility, user and database management
+- [SvelteKit](https://kit.svelte.dev) frontend built using design principles from [`shadcn-svelte`](https://www.shadcn-svelte.com/)
+- Multiple login flows (username, email, Oauth2)
+- API Connectors to preset and custom ticket vendors
+
+Omnidash is most useful to Managed Service Providers that have to keep track of customer tickets which aren't yet consolidated into a single system due to customer requirements.
+
+> [!WARNING]
+> This project is still in active development and should not be seen as production-ready.
+> Full documentation, guides and examples will be coming soon.
+
+## Setup overview
+
+### Frontend
 
 To install the project and its dependencies, follow these steps:
 
@@ -28,6 +40,28 @@ To install the project and its dependencies, follow these steps:
     pnpm install
     ```
 
+To develop this locally, you can use the following command:
+
+```sh-session
+pnpm run dev -- --open
+```
+
+### Backend
+
+You can run the backend locally by running:
+
+```sh-session
+./backend/pocketbase serve
+```
+
+You can use the `--help` flag to determine if you need additional setup.
+
+Alternatively, you can run our Docker image:
+
+```sh-session
+docker run us-central1-docker.pkg.dev/omnidash-414814/omnidash-pb/main
+```
+
 ### Environment Variables
 
 After setting up the required services, you need to set the corresponding environment variables in the `/.env` file. To do this, follow these steps:
@@ -38,7 +72,7 @@ After setting up the required services, you need to set the corresponding enviro
     ```
 2.  Open the `.env` file in a text editor and populate the values for the services mentioned above.
 
-## Build
+### Build
 
 To build the project, execute the following command:
 
@@ -46,10 +80,18 @@ To build the project, execute the following command:
 pnpm build
 ```
 
-## Run
+## Security
 
-To run the project locally, use the following command:
+If you discover a security vulnerability within PocketBase, please send an e-mail to **bart at vanderbraak.nl**.
 
-```sh-session
+All reports will be promptly addressed, and you'll be credited accordingly.
-pnpm turbo run dev
+
-```
+## Contributing
+
+PocketBase is free and open source project licensed under the [GPLv3](LICENSE).
+You are free to do whatever you want with it, even offering it as a paid service.
+
+You could help continuing its development by:
+
+- [Contribute to the source code](.github/CONTRIBUTING.md)
+- [Suggest new features and report issues](https://github.com/bartvdbraak/omnidash/issues)

src/routes/+page.svelte

@@ -13,11 +13,7 @@
 		<h1
 			class="bg-gradient-to-r from-zinc-800 via-zinc-800/60 to-zinc-800 bg-clip-text pb-4 text-4xl font-extrabold tracking-tight text-transparent dark:from-zinc-200/60 dark:via-zinc-200 dark:to-zinc-200/60 sm:text-5xl md:text-6xl lg:text-7xl"
 		>
-			<span class="inline-block text-balance align-top decoration-inherit">
+			<span class="inline-block text-balance align-top decoration-inherit"> Omnidash </span>
-				One Dashboard
-				<br />
-				Countless Solutions
-			</span>
 		</h1>
 		<p class="mb-8 text-sm text-zinc-800 dark:text-zinc-300 md:text-xl">
 			Tame ticket overload and keep your operations teams sane