diff --git a/README.md b/README.md index 3011bbe..fa03401 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,43 @@ One click to init an excalidraw with collaboration. -Docs: +Snapshot: + +![snapshot](./_assets/snapshot.png) + +Demo: + +WIP + +Related docs: - [Self hosted online collaborative drawing platform Excalidraw | Log4D](https://en.blog.alswl.com/2022/10/self-hosted-excalidraw/) - [私有化在线协同画图平台 Excalidraw | Log4D]( https://blog.alswl.com/2022/10/self-hosted-excalidraw/ ) -Build and Run: + +## Build and Run + +Clone, patch, and build: ``` +git clone --recursive git@github.com:alswl/excalidraw-collaboration.git +cd excalidraw-collaboration git config submodule.excalidraw.ignore all # ignore submodule changes, we will patch them -make patch -make images +make patch images git commit -a -m 'feat: new image' make bump-version docker-compose up ``` -Browse: +Browse it: - open http://127.0.0.1/ ,and you will see the excalidraw page - Click the `Live Collaboration` button, and you will see the collaboration page - Now you can share the collaboration page with your friends, and you can draw together. -Public Release: +About public network release: if you want to release your own excalidraw in public network, you should modify the `excalidraw.production.env` file, diff --git a/_assets/snapshot.png b/_assets/snapshot.png new file mode 100644 index 0000000..476cd85 Binary files /dev/null and b/_assets/snapshot.png differ