projview 0.8.3 → 1.0.0

package/README.md

@@ -1,8 +1,11 @@
 # projview
 
-ephemeral local previewer for **markdown** + **mermaid** files. run it in any
-directory, get a soft-dark cartoonish localhost view of every `.md` / `.mmd`
-under it, close it and nothing's left behind.
+a fast, zero-config local viewer for **markdown** + **mermaid** files. run it in
+any directory, get a soft-dark cartoonish localhost view of every `.md` / `.mmd`
+under it - rendered diagrams, search, live reload - close it and nothing's left
+behind.
+
+that's the product. point it at a docs folder, read comfortably, ctrl-c, gone.
 
 ## install
 
@@ -26,10 +29,28 @@ projview ./docs --port 5000
 projview /path/to/notes --no-open
 ```
 
-## use it from scripts or an AI
+## what you get
+
+| | |
+| --- | --- |
+| tree nav | every `.md` / `.mmd` under the root (skips `node_modules`, `dist`, dot-dirs) |
+| rendering | markdown + syntax-highlighted code + **mermaid diagrams** (with pan/zoom) |
+| search | `⌘K` palette - fuzzy filenames + full-text content with line snippets |
+| live reload | edit a file, the browser updates |
+| ephemeral | in-memory by default; nothing written to disk, nothing left behind |
+
+see [samples/architecture.md](samples/architecture.md) for a mermaid demo.
+
+---
+
+## beyond viewing (optional)
+
+the viewer is the point - everything below is opt-in and entirely ignorable.
 
-projview also has a **machine interface** - subcommands that print JSON to stdout
-and exit (no server, no browser), so an agent or script can query your docs:
+### machine interface
+
+subcommands that print JSON to stdout and exit (no server, no browser), if a
+script or agent wants to query the same docs:
 
 ```bash
 projview search "<query>" [path]   # ranked: filename matches + in-content hits w/ line snippets
@@ -37,7 +58,6 @@ projview tree [path]               # the file tree as JSON
 projview comment add <file> "…"    # leave a comment (--heading <id> to anchor a section)
 projview comments [file]           # list comments as JSON
 projview usage [path]              # views + searches recorded by the viewer
-projview search "mermaid" --demo   # quick test on the bundled docs
 ```
 
 ```jsonc
@@ -48,31 +68,18 @@ projview search "mermaid" --demo   # quick test on the bundled docs
                  "snippets": [ { "line": 68, "text": "### live reload" } ] } ] }
 ```
 
-## what it does
-
-| step | detail |
-| --- | --- |
-| walk | recursively finds `.md` / `.mmd`, skips `node_modules`, `dist`, dot-dirs |
-| index | builds an in-memory tree (nothing written to disk by default) |
-| serve | spawns a localhost site + opens your browser |
-| live | edits to files reload in the browser automatically |
-| comment | leave notes on a file, a section, or a text selection (browser or CLI) |
-
-> ephemeral by default - ctrl-c and it's gone. opt into persistence below.
+### comments
 
-## comments
+notes on a whole file, a heading, or a selected passage - from the viewer (the
+💬 button) or the CLI / HTTP API. text comments **re-anchor** as the doc changes
+and flag themselves *orphaned* only if the quoted text truly disappears. they
+need a persistent store to survive a restart; writes are **localhost-only** (an
+exposed instance is read-only).
 
-Leave notes on a whole file, a heading/section, or a selected passage - from the
-viewer (the 💬 button, bottom-right) or via the CLI / HTTP API. Text comments
-**re-anchor** as the doc changes and only flag themselves *orphaned* if the quoted
-text truly disappears. Comments persist when you opt into a store
-(`--persist` / `--store-url`); writes are **localhost-only** (an exposed instance
-is read-only).
+### persistence
 
-## persistence (opt-in)
-
-By default the index is in-memory and nothing is written to disk. Opt in for a
-faster warm start, or a queryable store an AI can read:
+by default the index is in-memory. opt in for a faster warm start, persistent
+comments, or a queryable store:
 
 ```bash
 projview docs --persist                                # sqlite cache in ~/.projview/cache
@@ -87,7 +94,5 @@ projview docs --store-url "$DATABASE_URL"              # your own postgres (need
 | `superlite` (JSON) | `--store superlite --persist` |
 | `custom` (sqlite/postgres URL) | `--store-url <url>` (or `DATABASE_URL`) |
 
-On re-run it reloads the cache and only re-reads files whose mtime changed.
-Connection strings come from env/`~/.projview` - never commit credentials.
-
-see [samples/architecture.md](samples/architecture.md) for a mermaid demo.
+on re-run it reloads the cache and only re-reads files whose mtime changed.
+connection strings come from env/`~/.projview` - never commit credentials.

package/docs/how-to-set-up.md

@@ -67,7 +67,7 @@ npm install
 npm run demo                 # preview the bundled docs/  (alias for --demo)
 npm start                    # index the current directory
 node bin/projview.js ./docs  # or call the CLI directly
-npm test                     # run the test suite (node:test, 49 tests)
+npm test                     # run the test suite (node:test, 54 tests)
 ```
 
 See the [project README](README.md) for the architecture and the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "projview",
-  "version": "0.8.3",
+  "version": "1.0.0",
   "description": "Ephemeral local previewer for markdown + mermaid files in any directory",
   "type": "module",
   "bin": {