From 51cfd6102a8b0decb819bf2e19f7994149381b2a Mon Sep 17 00:00:00 2001 From: Zimeng Xiong Date: Sat, 22 Nov 2025 14:41:08 -0800 Subject: [PATCH] improve README --- README.md | 62 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d753098..62166b6 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,74 @@ -[Image Description] +ExcaliDash Logo # ExcaliDash v0.1.0 -A self hosted dashboard and organizer for [Excalidraw](https://github.com/excalidraw/excalidraw) with live collaboration. +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](https://hub.docker.com) + +A self-hosted dashboard and organizer for [Excalidraw](https://github.com/excalidraw/excalidraw) with live collaboration features. + +## Screenshots + ![](dashboard.png) ![](demo.gif) -[Features](#Features) +## Table of Contents -[Installation](#Installation) +- [Features](#features) +- [Installation](#installation) + - [Docker Hub (Recommended)](#dockerhub-recommended) + - [Docker Build](#docker-build) +- [Development](#development) + - [Clone the Repository](#clone-the-repository) + - [Frontend](#frontend) + - [Backend](#backend) + - [Project Structure](#project-structure) +- [Credits](#credits) -[Development](#Development) +## Features -[Credits](#Credits) - -# Features - -## Persistent storage for all your drawings +
+Persistent storage for all your drawings ![](dashboardLight.png) -## Real time collaboration +
+ +
+Real time collaboration ![](collabDemo.gif) -## Search your drawings +
+ +
+Search your drawings ![](searchPage.png) -## Drag and drop drawings into collections +
+ +
+Drag and drop drawings into collections ![](collectionsPage.png) -## Export/import your drawings and databases for backup +
+ +
+Export/import your drawings and databases for backup ![](settingsPage.png) +
+ # Installation > [!CAUTION] > NOT for production use. This is just a side project (and also the first release), and it likely contains some bugs. -## Dockerhub (recommended) +## Docker Hub (Recommended) [Install Docker](https://docs.docker.com/desktop/) @@ -59,7 +85,7 @@ docker compose -f docker-compose.prod.yml up -d # Access the frontend at localhost:6767 ``` -## Docker build +## Docker Build [Install Docker](https://docs.docker.com/desktop/) @@ -78,7 +104,7 @@ docker compose up -d # Development -## Clone the repository +## Clone the Repository ```bash # Clone the repository (recommended) @@ -116,7 +142,7 @@ npx prisma db push npm run dev ``` -## Structure +## Project Structure ``` ExcaliDash/