@railway/inkwell 0.1.4 → 1.0.0

package/README.md

@@ -1,12 +1,12 @@
 # ✒️ Inkwell
 
-[![inkwell.build](https://img.shields.io/badge/inkwell.build-8b5cf6)](https://inkwell.build)
-[![llms.txt](https://img.shields.io/badge/llms.txt-8b5cf6)](https://inkwell.build/llms.txt)
-[![ci](https://img.shields.io/github/actions/workflow/status/railwayapp/inkwell/ci.yml?branch=main)](https://github.com/railwayapp/inkwell/actions)
-[![npm](https://img.shields.io/npm/v/@railway/inkwell)](https://www.npmjs.com/package/@railway/inkwell)
+[![inkwell.build](https://img.shields.io/badge/inkwell.build-7B3FA0)](https://inkwell.build)
+[![llms.txt](https://img.shields.io/badge/llms.txt-7B3FA0)](https://inkwell.build/llms.txt)
+[![ci](https://img.shields.io/github/actions/workflow/status/railwayapp/inkwell/ci.yml?branch=main&label=ci&color=7B3FA0)](https://github.com/railwayapp/inkwell/actions)
+[![npm](https://img.shields.io/npm/v/@railway/inkwell?color=7B3FA0)](https://www.npmjs.com/package/@railway/inkwell)
 
 Inkwell is a Markdown editor and renderer for React with an extensible plugin
-system and real-time collaboration support.
+system.
 
 ## Usage
 
@@ -19,11 +19,13 @@ pnpm add @railway/inkwell
 ### Editor
 
 ```tsx
+import "@railway/inkwell/styles.css";
 import { InkwellEditor } from "@railway/inkwell";
 import { useState } from "react";
 
 function App() {
   const [content, setContent] = useState("# Hello **world**");
+
   return <InkwellEditor content={content} onChange={setContent} />;
 }
 ```
@@ -49,19 +51,26 @@ pnpm dev
 
 ## Releases
 
-Releases are published to npm via GitHub Actions.
+Versioning and `CHANGELOG.md` are managed by [Changesets](https://github.com/changesets/changesets). Publishing to npm runs via GitHub Actions on a `v*` tag push.
+
+When you open a PR that should show up in the changelog:
+
+```bash
+pnpm changeset   # pick bump type, write a user-facing summary
+```
+
+Commit the generated `.changeset/*.md` file alongside your code.
+
+To cut a release from `main`:
 
 ```bash
-cd packages/inkwell
-npm version patch --no-git-tag-version  # or minor / major
-cd ../..
-git add packages/inkwell/package.json
-git commit -m "🚀 release: v$(node -p "require('./packages/inkwell/package.json').version")"
+pnpm changeset version   # bumps packages/inkwell/package.json + writes CHANGELOG.md
+git commit -am "🚀 release: v$(node -p "require('./packages/inkwell/package.json').version")"
 git tag "v$(node -p "require('./packages/inkwell/package.json').version")"
-git push && git push --tags
+git push --follow-tags
 ```
 
-Pushing a `v*` tag triggers the publish workflow.
+Pushing the `v*` tag triggers the publish workflow.
 
 ## License