From afeba9d4a38cb0c98d99ee7ebefef928a5e07f3b Mon Sep 17 00:00:00 2001
From: Jesse Wierzbinski <contact@cpluspatch.com>
Date: Mon, 6 May 2024 09:17:12 -1000
Subject: [PATCH] docs: :memo: Update README to add more info

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d0b0297..eb36a2f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,52 @@
-# FE
\ No newline at end of file
+<p align="center">
+  <a href="https://lysand.org"><img src="https://cdn.lysand.org/logo-long-dark.webp" alt="Lysand Logo" height="110"></a>
+</p>
+
+# Lysand-FE
+
+**Lysand-FE** is a beautiful, fast and responsive front-end for the Lysand project.
+
+## Features
+
+- [x] Timelines: public, home, local
+- [x] Login
+- [x] Notifications
+- [x] Replies
+- [x] Quotes
+- [x] Markdown posts
+- [x] Dark mode
+- [x] Following
+- [ ] Settings
+- [ ] Profile editing
+
+## Tech Stack
+
+- [**Nuxt**](https://nuxt.com) - The Intuitive Vue Framework
+- [**TailwindCSS**](https://tailwindcss.com) - A utility-first CSS framework
+- [**TypeScript**](https://typescriptlang.org) - A typed superset of JavaScript
+
+## Installation
+
+Lysand-FE is included in the provided `docker-compose` file during [Lysand Server installation](https://github.com/lysand-org/lysand/blob/main/docs/installation.md).
+
+To have Lysand-FE and Lysand Server running on the same domain, edit the Lysand Server configuration to point to the Lysand-FE container's address (`frontend` category inside config).
+
+### Manual Installation
+
+Here are the steps to install Lysand-FE manually:
+
+#### Docker/Podman
+
+```yaml
+services:
+    fe:
+        image: ghcr.io/lysand-org/lysand-fe:main
+        container_name: lysand-fe
+        restart: unless-stopped
+        networks:
+            - lysand-net
+        environment:
+            NUXT_PUBLIC_API_HOST: https://yourserver.com
+```
+
+Then, the frontend will be available at `http://localhost:3000` inside the container. To link it to a Lysand Server, set the `NUXT_PUBLIC_API_HOST` environment variable to the server's URL.
\ No newline at end of file