update readme and add installation docs

README.md

@@ -2,7 +2,7 @@
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="./assets/logo-white.png">
     <source media="(prefers-color-scheme: light)" srcset="./assets/logo-black.png">
-    <img alt="Lagon logo" height="60px" src="./assets/logo-white.png">
+    <img alt="Lagoss logo" height="60px" src="./assets/logo-white.png">
   </picture>
   <p align="center">
     Deploy Serverless Functions at the Edge
@@ -19,16 +19,16 @@
 
 ## About
 
-Lagon is an open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions close to users.
+Lagoss is a fork of [Lagon](https://github.com/lagonapp/lagon) an open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions.
 
-> **Note**: Lagon is in Alpha. Get access to Lagon Cloud via the [waitlist](https://tally.so/r/n9q1Rp)
-
-Current status:
-
-- Dev: In heavy development, features are being added and APIs have breaking changes
-- **Alpha**: Missing features and bugs to fix, progressive access to Lagon Cloud ([waitlist](https://tally.so/r/n9q1Rp))
-- ~Beta~: Stable APIs, last features are being added, Lagon Cloud available without a waitlist
-- ~General Availability~: Cloud and self-hosted versions available for production usage
+> [!WARNING]
+> **Current status:**
+>
+> The project was forked from [Lagon](https://github.com/lagonapp/lagon) with the
+> intention to continue development. There is currently a public testing instance
+> deployed at <https://app.lagoss.com>. However it should be only used for basic
+> testing and data might be deleted at any point. If you want a proper setup,
+> please deploy your own instance.
 
 ## Packages
 
@@ -39,7 +39,7 @@ Current status:
 - **[runtime](./crates/runtime)** Rust JavaScript Runtime, using V8 Isolates
 - **[serverless](./crates/serverless)** HTTP entrypoint for Functions, using the Runtime and exporting metrics
 - **[ui](./packages/ui)** Design system
-- **[wpt-runner](./crates/wpt-runner)** Run web-platform-tests on Lagon
+- **[wpt-runner](./crates/wpt-runner)** Run web-platform-tests on Lagoss
 - **[www](./www)** Public website
 
 ## Features
@@ -51,27 +51,15 @@ Current status:
 - CLI to manage Functions and develop locally
 - Deploy at the Edge using the Cloud version, or self-host it
 
-## Roadmap
-
-The roadmap is accessible to anyone on GitHub. Feel free to open an issue to discuss new features that you would like to see implemented.
-
-[See the roadmap on GitHub](https://github.com/orgs/lagonapp/projects/1)
-
-## Contributing
-
-[See the contributing guide](https://docs.lagon.app/contributing)
-
 ## How it works
 
-Lagon uses V8 Isolates, which are sandboxed environments used to run plain JavaScript. That means each Function's memory is isolated from each others, and you can run a lot of them at the same time with very few resources. [Node.js](https://nodejs.org/), [Electron](https://www.electronjs.org/), [Deno](https://deno.land/) (and [Deno Deploy](https://deno.com/deploy)), [Cloudflare Workers](https://workers.cloudflare.com/) are also using V8 Isolates to execute JavaScript.
+Lagoss uses V8 Isolates, which are sandboxed environments used to run plain JavaScript. That means each Function's memory is isolated from each others, and you can run a lot of them at the same time with very few resources. [Node.js](https://nodejs.org/), [Electron](https://www.electronjs.org/), [Deno](https://deno.land/) (and [Deno Deploy](https://deno.com/deploy)), [Cloudflare Workers](https://workers.cloudflare.com/) are also using V8 Isolates to execute JavaScript.
 
 Starting an Isolate is a lot faster than starting a whole Node.js process, which allows for almost free cold starts.
 
-## Sponsors ❤️
-
-Thanks a lot to every current and past sponsor!
+## Installation
 
-![Sponsors list](./assets/sponsors.png)
+Learn how you can [install](./docs/installation.md) your own Lagoss instance.
 
 ## License
 

docs/installation.md

@@ -0,0 +1,30 @@
+# Installation
+
+Deploying your own instance of Lagoss is straightforward and only require some basic knowledge of Docker.
+
+## Requirements
+
+- A linux server with:
+  - a static ip
+  - [docker](https://docs.docker.com/engine/install/)
+  - [docker-compose](https://docs.docker.com/compose/install/)
+- A wildcard domain (exp: `*.lagoss.com`) where you can set a wildcard to your server
+- Github O-Auth app
+
+## Download `docker-compose.yml` & `.env`
+
+```bash
+# download docker-compose.yml
+wget ...
+
+# download .env file
+wget ...
+```
+
+### Create Github O-Auth app
+
+For the login you need to configure
+
+### Configure your settings in `.env`
+
+### Start setup