docs: update README

toeverything · May 30, 2024 · 97cd4f0 · 97cd4f0
1 parent 2aeb83e
commit 97cd4f0
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,38 @@
 # NoteSuite
 
-Experimental note-taking app based on local-first infrastructure.
+Experimental note-taking app based on [BlockSuite](https://github.com/toeverything/blocksuite) and [ystream](https://github.com/yjs/ystream).
+
+![screenshot-basic](./images/screenshot-basic.jpg)
+
+## Overview
+
+* Isomorphic client and web builds.
+* Mapping workspace into files hosted on WebDAV.
+* VSCode extension for file editing.
+* Documents persisted as `Y.Doc` in ystream instance.
+
+## Development
+
+Install deps:
+
+```sh
+pnpm i
+```
+
+Start server and client:
+
+```sh
+pnpm dev:server
+pnpm dev:client
+```
+
+The VSCode extension can be started in VSCode:
+
+<img src="./images/screenshot-debugger.jpg" alt="screenshot-debugger" width="200">
+
+
+Run E2E tests (make sure to run `npx playwright install` before):
+
+```sh
+pnpm test
+```
diff --git a/images/notesuite-arch.png b/images/notesuite-arch.png
diff --git a/images/screenshot-basic.jpg b/images/screenshot-basic.jpg
diff --git a/images/screenshot-debugger.jpg b/images/screenshot-debugger.jpg