From 2ae85ac76ab7fb878d333aac151e429844ffea21 Mon Sep 17 00:00:00 2001 From: Abhinav Raut Date: Fri, 21 Feb 2025 22:44:14 +0530 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1533a36..74b0a4c 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,25 @@ # Libredesk -Fully open-source, self-hosted customer support desk. Single binary app. - -> This project is currently in **alpha**. Features and APIs may change and are not yet fully tested. +Open source, self-hosted customer support desk. Single binary app. Visit [libredesk.io](https://libredesk.io) for more info. Check out the [**Live demo**](https://demo.libredesk.io/). ![Screenshot_20250220_231723](https://github.com/user-attachments/assets/55e0ec68-b624-4442-8387-6157742da253) +> [!CAUTION] +> This project is currently in **alpha**. Features and APIs may change and are not yet fully tested. + + ## Developer Setup #### Prerequisites - **go** - **pnpm** -- **PostgreSQL >= 13** -- **Redis** +- **postgreSQL >= 13** +- **redis** 1. **Clone the repository**: @@ -37,7 +39,7 @@ Visit [libredesk.io](https://libredesk.io) for more info. Check out the [**Live ``` - Edit the `config.toml` file to configure your postgres and redis connection settings. -3. **Run in Development Mode**: +3. **Run in development mode**: - Backend: `make run-backend` - Frontend: `make run-frontend`