simplify 3

frontend/obsidian-plugin/README.md

@@ -1,63 +1,33 @@
-# Obsidian Sample Plugin
+# VaultLink Obsidian plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Syncs an Obsidian vault with the VaultLink server, including active editor text,
+selections, remote cursors, history and connection status. Use an API v5 server.
+The vault configuration directory, Git metadata and trash are ignored by default.
 
-This project uses TypeScript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
+From `frontend`:
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+```sh
+npm run build -w sync-client -w vault-link-obsidian-plugin
+npm run test -w vault-link-obsidian-plugin
+```
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
+The production bundle is in `obsidian-plugin/dist`: `main.js`, `manifest.json`
+and `styles.css`. Copy those files into the vault's plugin directory to install.
 
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+Desktop Obsidian shares the CLI's Node filesystem and atomic metadata adapters.
+The complete client record remains in the plugin's `data.json`; it includes
+settings, sync state, queued logical notifications and the server history
+checkpoint. Mobile uses Obsidian's storage and plugin data APIs. Because mobile
+writes overwrite existing files, exclusive creation uses a disposable input for
+`DataAdapter.copy` in `.vault-link-sync`. This is not a filesystem journal or a
+recovery payload.
 
-## First time developing plugins?
+Raw create/modify/delete events wake a fresh scan, including events caused by
+sync and editor replacements. Obsidian's logical rename event preserves file
+and directory move identities. Editor snapshots include unsaved text and
+selections; content application updates both disk and the active editor.
 
-Quick starting guide for new plugin devs:
-
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
-
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+Adapter tests cover unsaved text, cursor restoration, exclusive creation and
+storage failures. The repository E2E runner builds the plugin and tests its
+filesystem adapter against the server alongside real CLI processes. These tests
+do not launch Obsidian itself.