From 0916f54045ac39a32a68a3951f54150fd1a71f06 Mon Sep 17 00:00:00 2001
From: Andras Schmelczer <andras@schmelczer.dev>
Date: Sun, 17 Aug 2025 14:59:21 +0100
Subject: [PATCH] Small readme improvements

---
 README.md | 31 ++++++++++++++++++++-----------
 1 file changed, 20 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index d0bbb264..1eb7a1c2 100644
--- a/README.md
+++ b/README.md
@@ -5,22 +5,20 @@
 [![Publish server Docker image](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-docker.yml)
 [![Publish Obsidian plugin](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml/badge.svg)](https://github.com/schmelczer/vault-link/actions/workflows/publish-plugin.yml)
 
-
 ## Develop
 
 ### Install [nvm](https://github.com/nvm-sh/nvm)
 
-- `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash`
-- `nvm install 22`
-- `nvm use 22`
-- Optionally set the system-wide default: `nvm alias default 22`
-
+-   `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash`
+-   `nvm install 22`
+-   `nvm use 22`
+-   Optionally set the system-wide default: `nvm alias default 22`
 
 ### Set up Rust
 
-- Install [`rustup`](https://rustup.rs): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
-- Install [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer): `curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh`
-- `cargo install cargo-insta sqlx-cli cargo-edit`
+-   Install [`rustup`](https://rustup.rs): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
+-   Install [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer): `curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh`
+-   `cargo install cargo-insta sqlx-cli cargo-edit`
 
 ### Install Obsidian on Linux
 
@@ -31,6 +29,18 @@ flatpak install flathub md.obsidian.Obsidian
 flatpak run md.obsidian.Obsidian
 ```
 
+#### Run in development mode
+
+Start the server:
+
+```sh
+cd sync-server && cargo run config-e2e.yml
+```
+
+```sh
+cd frontend && npm run dev
+```
+
 ### Scripts
 
 #### Update HTTP API TS bindings
@@ -45,7 +55,6 @@ scripts/update-api-types.sh
 scripts/bump-version.sh patch
 ```
 
-
 #### Run E2E tests
 
 ```sh
@@ -56,4 +65,4 @@ And to clean up the logs & database files, run `scripts/clean-up.sh`
 
 ## Projects
 
-- [Sync server](./sync-server/README.md)
+-   [Sync server](./sync-server/README.md)