@peaske7/readit 0.2.0 → 0.3.0-rc.0

package/README.md

@@ -27,12 +27,100 @@ readit <file> --host 0.0.0.0  # Custom host (default: 127.0.0.1)
 readit <file> --no-open       # Don't auto-open browser
 readit <file> --clean         # Clear existing comments
 
-readit list                  # List all files with comments
-readit show <file>           # Show comments for a file
+readit list                   # List all files with comments
+readit show <file>            # Show comments for a file
+readit open <files...>        # Add files to running server
+readit completion zsh         # Output shell integration script
 ```
 
 Select text to add comments. Comments appear as margin notes. Copy all comments formatted for AI with a single click.
 
+## Shell Integration
+
+readit provides rich shell completions and an `@` file picker for zsh, bash, and fish.
+
+### Zsh (recommended)
+
+Add to your `~/.zshrc`:
+
+```bash
+eval "$(readit completion zsh)"
+```
+
+This gives you:
+
+- **`@` file picker** -- type `readit @` and press Tab to open an fzf-powered markdown file picker with preview. Type `readit @test` + Tab to pre-filter to files matching "test".
+- **Standard completion** -- Tab-complete subcommands (`open`, `list`, `show`, `completion`), options (`--port`, `--clean`), and markdown file paths.
+- **Syntax highlighting** -- `@file.md` tokens are highlighted in cyan (requires [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting)).
+- **`ri` alias** -- shorthand for `readit`.
+
+Optional dependencies for the best experience: [fzf](https://github.com/junegunn/fzf), [fd](https://github.com/sharkdp/fd), [bat](https://github.com/sharkdp/bat).
+
+### Bash
+
+```bash
+eval "$(readit completion bash)"
+```
+
+### Fish
+
+```fish
+readit completion fish | source
+```
+
+## Neovim Plugin
+
+The `nvim-readit` plugin lets you open markdown files in readit directly from Neovim. Edits in Neovim are reflected in the browser automatically via live reload.
+
+### Installation (lazy.nvim)
+
+```lua
+{
+  dir = "path/to/readit/nvim-readit",  -- or install from repo
+  ft = "markdown",
+  opts = {},
+}
+```
+
+### Commands
+
+| Command | Keymap | Description |
+|---|---|---|
+| `:ReaditOpen` | `<leader>ro` | Open current buffer in readit |
+| `:ReaditReload` | `<leader>rr` | Save and reload in browser |
+| `:ReaditStop` | `<leader>rq` | Stop the readit server |
+| `:ReaditStatus` | `<leader>ri` | Show server status |
+| `:ReaditList` | `<leader>rl` | Pick from files with comments |
+| `:ReaditOpenFile <path>` | -- | Open a specific file |
+
+### Configuration
+
+```lua
+require("readit").setup({
+  bun_path = "bun",           -- Path to bun executable
+  port = 0,                   -- 0 = auto-select free port
+  host = "127.0.0.1",
+  auto_open = true,           -- Open browser on :ReaditOpen
+  keymap_prefix = "<leader>r", -- Change keymap prefix
+})
+```
+
+Run `:checkhealth readit` to verify your setup.
+
+## Live Reload
+
+readit watches open documents for changes and automatically refreshes the browser. This works with any editor:
+
+- **Standard saves** -- detected via `fs.watch()` change events.
+- **Vim/Neovim/Emacs saves** -- these editors write to a temp file then rename. readit detects rename events and re-establishes the file watcher automatically.
+- **SSE auto-reconnect** -- if the browser loses its connection to the server, it reconnects with exponential backoff.
+
+No configuration needed. Open a file with `readit`, edit it in any editor, and the browser updates within ~200ms.
+
+## VS Code Extension
+
+The `vscode-readit` extension provides a side-by-side preview panel inside VS Code. See [vscode-readit/](vscode-readit/) for details.
+
 ## Development
 
 ```bash

package/biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.4.9/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.4.15/schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",
@@ -19,9 +19,7 @@
       "style": {
         "noNonNullAssertion": "off"
       },
-      "correctness": {
-        "useExhaustiveDependencies": "warn"
-      },
+      "correctness": {},
       "complexity": {
         "noForEach": "off",
         "noImportantStyles": "off"
@@ -37,9 +35,7 @@
         "useSemanticElements": "warn",
         "useFocusableInteractive": "warn"
       },
-      "security": {
-        "noDangerouslySetInnerHtml": "warn"
-      }
+      "security": {}
     }
   },
   "css": {
@@ -65,5 +61,19 @@
       "!!**/test-results"
     ],
     "ignoreUnknown": true
-  }
+  },
+  "overrides": [
+    {
+      "includes": ["**/*.svelte"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noUnusedImports": "off",
+            "noUnusedVariables": "off",
+            "noUnusedFunctionParameters": "off"
+          }
+        }
+      }
+    }
+  ]
 }