docs: Clarify README and bump release metadata

Author: smcllns

README.md

@@ -1,92 +1,71 @@
-# HTML Docs
+# HTML Docs Obsidian Plugin
+
+A zero-dependency minimal plugin to enable .html docs inside Obsidian. Inspired by [Thariq's "unreasonable effectiveness of HTML"](https://x.com/trq212/status/2052809885763747935).
 
-A zero-dependency minimal plugin to bring the [unreasonable effectiveness of HTML](https://x.com/trq212/status/2052809885763747935) to Obsidian.
 
 * The HTML is rendered in a sandboxed `<iframe>`.
-* JS can run inside the HTML for interactivity, but the iframe is isolated from Obsidian and your vault.
-* Nothing else. The plugin is ~75 lines of code, ~100 lines of config, and ~520 lines of test.
+* JS can run inside the HTML for interactivity but the iframe is isolated from your other notes and Obsidian's own data.
+* No other bells and whistles.
 
-Fork and extend if you want other features.
+The plugin is ~75 lines of code, ~100 lines of config, ~520 lines of test, and requires no external dependencies.
 
 ## Demo
 
-A minimal plugin that lets you work with .md AND .html docs inside Obsidian
+A demo page (`test/fixture.html`) demonstrates all the passing HTML features.
 
 ![](demo.png)
 
-## Install
-
-The easy path: [install from the Obsidian Community Plugins directory](https://community.obsidian.md/plugins/html-docs), or browse to **Settings → Community plugins → Browse**, search **HTML Docs**, and click Install.
-
-After install, turn on **Settings → Files & Links → Detect all file extensions** so `.html` files appear in the file explorer. The plugin shows a one-time notice on load if it isn't already on.
-
-### Install manually
-
-1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/smcllns/obsidian-plugin-html-docs/releases/latest) and drop them into `<vault>/.obsidian/plugins/html-docs/`.
-2. Enable **HTML Docs** in Obsidian's Community Plugins settings.
-3. Turn on the **Detect all file extensions** setting as above.
+## Installation
 
-Releases are built and signed by GitHub Actions ([release.yml](.github/workflows/release.yml)) so the binaries carry a [build attestation](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) you can verify against the source.
+> Note: Obsidian only shows `.md` files in your file explorer, by default. To see your `.html` files too, be sure to enable: **Settings → Files & links → Show all file types**
 
-To build from source instead: `npm install && npm run build` produces `dist/html-docs/` ready to copy.
+### Install from Obsidian directly
 
-## What works
+* Go to Obsidian Community Plugins: [community.obsidian.md/plugins/html-docs](https://community.obsidian.md/plugins/html-docs)
+* Click Install
 
-Anything an isolated page can do without server-side help: HTML, CSS (gradients, grid, animations, custom properties), JavaScript (ES2020+, Promises, `setInterval`, DOM events), inline SVG, Canvas 2D, forms, and absolute HTTPS resources (images, fetch with CORS).
-
-See demo: [test/fixture.html](test/fixture.html)
-
-## What doesn't work (by design)
-
-This plugin intentionally omits `allow-same-origin`, so each HTML page gets an opaque origin — the browser treats it as isolated content. JS still runs, but it can't reach your vault, your notes, or Obsidian's own data.
-
-Which blocks:
+### Install manually
 
-- `localStorage`, `sessionStorage`, `IndexedDB`, `document.cookie`
-- Reading the parent (`window.parent.*`) — `postMessage` still works
-- Vault-relative URLs like `<img src="attachments/foo.png">` — use absolute HTTPS or data URLs
-- Service workers, geolocation, clipboard, notifications
+1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/smcllns/obsidian-plugin-html-docs/releases/latest)
+2. Place those files into `<vault>/.obsidian/plugins/html-docs/`.
+3. Enable **HTML Docs** in Obsidian's Community Plugins settings.
 
+Releases are built and signed by GitHub Actions ([.github/workflows/release.yml](.github/workflows/release.yml)) so the binaries carry a [build attestation](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) you can verify against the source.
 
-## Dev
+### Build and install from source
 
 ```bash
+git clone https://github.com/smcllns/obsidian-plugin-html-docs/
 npm install
 npm run dev      # watch + rebuild
-npm run build    # production bundle
+npm run build    # production bundle at `dist/html-docs/`
 ```
 
-Open any `.html` or `.htm` file in your vault — Obsidian will route it through the plugin's view.
+## Test
+
+An E2E test runner validates features and sandboxing are working correctly. Requires `obsidian-cli`, Obsidian running with a vault open, the plugin installed and enabled, and `jq` available.
 
-For a tighter loop, symlink your vault's plugin folder to the build output so every rebuild is picked up without a copy:
 
 ```bash
-ln -sf "$(pwd)/dist/html-docs" "<vault>/.obsidian/plugins/html-docs"
+npm test
 ```
 
-Then `obsidian-cli plugin:reload id=html-docs` (or `Cmd-P → Reload app`) loads the new build.
+The script copies `test/fixture.html` into the vault temporarily, opens it in Obsidian, uses `obsidian-cli eval` to inspect the plugin view and verify the iframe exists with the expected sandbox and blob URL settings, collects the iframe’s own self-test results via `postMessage`, then cleans up.
 
-## Test
+See `test/fixture.html` for the full list of features exercised — and the inline notes for what is intentionally blocked.
 
-A smoke-test suite drives a running Obsidian instance via `obsidian-cli`.
+## Obsidian Official Resources
 
-```bash
-npm test
-```
+* Developer docs: [docs.obsidian.md](https://docs.obsidian.md)
 
-Requires Obsidian running with a vault open, the plugin installed and enabled, and `jq` available. The script copies `test/fixture.html` into the vault temporarily, opens it, verifies the iframe shape from outside Obsidian and collects the iframe's own self-test results via `postMessage`, then cleans up.
+## Feedback / Support
 
-See `test/fixture.html` for the full list of features exercised — and the inline notes for what is intentionally blocked.
+This plugin will stay simple and do this one thing well.
 
-## The original prompt
+File issues here, or message me on X (@smcllns).
 
-```markdown
-Research obsidian plugin best practices. Then write a minimalist obsidian plugin which lets me view html files similar to md files inside obsidian.
-They will be single html files but they need to be able to run JavaScript.
+If you want more features, please fork and customize as you need.
 
-I want to avoid complexity and aim for a simple and reliable.
+## Known Issues
 
-Include a test html page which contains all the components we expect to work (include svg).
-At the bottom include any components that are known to **not** work.
-Include a test runner in the repo to exercise and validate so we have clear expectations of what should work and small automated test suite.
-```
+1. **Does not support Obsidian Canvas or embeds.** HTML files in Canvas, and embeds in a doc (e.g. `![[doc.html]]`) continue to show the same placeholder as before.

manifest.json

@@ -1,9 +1,9 @@
 {
 	"id": "html-docs",
 	"name": "HTML Docs",
-	"version": "1.0.3",
+	"version": "1.0.4",
 	"minAppVersion": "1.4.0",
-	"description": "A minimal zero-dependency plugin that lets you write docs in .md or .html and open both inside your vault.",
+	"description": "A zero-dependency minimal plugin to enable .html docs inside Obsidian. Inspired by Anthropic's 'unreasonable effectiveness of HTML'",
 	"author": "smcllns",
 	"authorUrl": "https://github.com/smcllns",
 	"isDesktopOnly": false

package-lock.json

@@ -1,14 +1,18 @@
 {
 	"name": "html-docs",
-	"version": "1.0.3",
-	"description": "A minimal zero-dependency Obsidian plugin that lets you write docs in .md or .html and open both inside Obsidian.",
+	"version": "1.0.4",
+	"description": "A zero-dependency minimal plugin to enable .html docs inside Obsidian. Inspired by Anthropic's 'unreasonable effectiveness of HTML'",
 	"main": "main.js",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"test": "bash test/test.sh"
 	},
-	"keywords": [],
+	"keywords": [
+		"obsidian",
+		"html",
+		"obsidian-plugin"
+	],
 	"author": "smcllns",
 	"license": "MIT",
 	"devDependencies": {
@@ -18,4 +22,4 @@
 		"tslib": "2.4.0",
 		"typescript": "4.7.4"
 	}
-}
+}

package.json

@@ -1,3 +1,4 @@
 {
-	"1.0.3": "1.4.0"
+	"1.0.3": "1.4.0",
+	"1.0.4": "1.4.0"
 }