@suzumiyaaoba/mdxr 0.1.0 → 0.3.0

package/README.md

@@ -28,13 +28,24 @@ Render an `.mdx` file (or stdin) to a standalone HTML file.
 mdxr render plan.mdx                 # → plan.html
 mdxr render plan.mdx -o out.html     # custom output path
 cat plan.mdx | mdxr render > out.html # stdin → stdout
+mdxr render plan.mdx --open          # also open plan.html in the default browser
 mdxr render plan.mdx --no-hydrate    # static HTML, no client bundle
 mdxr render plan.mdx --format json   # machine-readable errors
 ```
 
 ### `mdxr serve [file]`
 
-Preview a document in the browser with live reload (`-p, --port`, default `3737`).
+Preview a document in the browser with live reload (`-p, --port`, default `3737`; `--open` to launch the browser once serving).
+
+### `mdxr text [file]`
+
+Render an `.mdx` document to plain Markdown — every component becomes an ASCII/text stand-in (status checkbox lists, block-bar charts, GFM tables, `<details>` disclosures) so the document stays readable in any Markdown viewer or terminal. Interactive-only widgets (dialogs, menus, shadcn chrome) degrade to their text content; unknown components warn to stderr and keep their children.
+
+```sh
+mdxr text plan.mdx                  # → plan.txt.md
+mdxr text plan.mdx -o plan.md       # custom output path
+cat plan.mdx | mdxr text > plan.md  # stdin → stdout
+```
 
 ### `mdxr catalog`
 
@@ -51,6 +62,27 @@ mdxr init --tool all       # all supported tools
 mdxr init --global         # into your home directory instead
 ```
 
+Local installs also add `.mdxr/` to the project's `.gitignore` — the untracked scratch dir agents write documents to.
+
+## Agent skill
+
+The `mdxr` skill teaches coding agents the component catalog and the render workflow. Install it into your project (or globally) with the [`skills` CLI](https://github.com/vercel-labs/skills):
+
+```sh
+npx skills add Suzumiyaaoba/mdxr --skill mdxr
+# add -g for a global install, or -a claude-code to target a specific agent
+```
+
+Then ask your agent, for example:
+
+> Use the mdxr skill to write an implementation plan for the auth feature and render it to HTML.
+
+Not just plans — any deliverable works (reports, reviews, investigation summaries, …). To make this automatic, add a standing instruction to your agent config (e.g. `AGENTS.md` / `CLAUDE.md`):
+
+```md
+- Whenever the user explicitly asks for a deliverable with mdxr, use the mdxr skill to write and render it.
+```
+
 ## License
 
 MIT