@vortexlabs/kirari-react 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vortexlabs/kirari-react
 
+## 1.0.1
+
+### Patch Changes
+
+- 3ee99c0: Update the package homepage and documentation links to https://kirari.sh.
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -1,8 +1,11 @@
 # @vortexlabs/kirari-react
 
-Kirari highlighting as React elements. `<Code>` renders tokens as `<span>`
-elements, with no `dangerouslySetInnerHTML` and no hooks, so it works as a
-Server Component.
+Syntax highlighting for React 19, built on
+[`@vortexlabs/kirari`](https://github.com/vortexkit/kirari/blob/main/packages/kirari/README.md).
+`<Code>` renders code as React elements and works in Server Components. Use the
+optional streaming hook for code that arrives in chunks.
+
+[Documentation](https://kirari.sh/docs/) · [Playground](https://kirari.sh/playground/)
 
 ## Install
 
@@ -19,19 +22,29 @@ import { Code } from '@vortexlabs/kirari-react'
 import { typescript } from '@vortexlabs/kirari/languages/typescript'
 import '@vortexlabs/kirari/theme.css'
 
-<Code language={typescript} highlightLines={[1, [3, 4]]}>{source}</Code>
+export const CodeExample = () => (
+  <Code language={typescript}>
+    {'const greeting: string = "Hello"'}
+  </Code>
+)
 ```
 
 Output is `<pre class="kirari"><code>…</code></pre>` with the standard
-`kirari-*` classes, so every Kirari theme works. `language` defaults to
+`kirari-*` classes, so every Kirari theme works. Code text is escaped by React;
+the component does not use `dangerouslySetInnerHTML`. `language` defaults to
 JavaScript. Other props go to the `<pre>`.
 
+## Lines and customization
+
+Use `highlightLines={[1, [3, 4]]}` to mark line 1 and lines 3–4. Style
+`.kirari-line-highlighted` to choose the highlight's appearance.
+
 | Prop | Effect |
 | --- | --- |
 | `lines` | Wrap each line in `<span class="kirari-line" data-line="n">`. |
 | `highlightLines` | Lines or `[first, last]` ranges get `kirari-line-highlighted`. Implies `lines`. |
 | `lineClassName` | `(line) => class` for a line wrapper. `line` is `{ number, start, end }`. |
-| `decorations` | `{ start, end, className }` source ranges, as in [decorations](../../docs/decorations.md). |
+| `decorations` | `{ start, end, className }` source ranges, as in [decorations](https://github.com/vortexkit/kirari/blob/main/docs/decorations.md). |
 | `classes` | Extra classes per token type, e.g. `{ keyword: 'kw' }`. |
 | `tokenClassName` | `(token) => class` per token. |
 | `tokens` | Pre-scanned tokens instead of `children`. |
@@ -46,15 +59,36 @@ Line numbers are CSS:
 
 ```tsx
 'use client'
+
+import { Code } from '@vortexlabs/kirari-react'
 import { useTokenStream } from '@vortexlabs/kirari-react/stream'
+import { javascript } from '@vortexlabs/kirari/languages/javascript'
+import '@vortexlabs/kirari/theme.css'
+
+export const StreamExample = () => {
+  const { tokens, write, reset } = useTokenStream(javascript)
 
-const { tokens, write, end, reset } = useTokenStream(javascript)
-// write(chunk) as text arrives, then end()
-return <Code tokens={tokens} />
+  return (
+    <>
+      <button type="button" onClick={() => write('const count = 42\n')}>
+        Append a line
+      </button>
+      <button type="button" onClick={reset}>Reset</button>
+      <Code tokens={tokens} />
+    </>
+  )
+}
 ```
 
-- Rescans only the unfinished tail. See [token streaming](../../docs/streaming.md).
+This example adds one chunk per click. In your app, call `write(chunk)` as text
+arrives. The hook also returns `end()`, which closes the stream when it is complete.
+
+- Built-in JavaScript, TypeScript, and JSON reuse completed scanning work. Other languages rescan the full source. Long unfinished tokens can still be expensive; see [token streaming](https://github.com/vortexkit/kirari/blob/main/docs/streaming.md).
 - Changing `language` starts a new, empty stream.
 - After `end()`, call `reset()` before writing again.
 - `/stream` is a client module; `<Code>` is not.
 - Managing tokens yourself? Use `createTokenStream` from `@vortexlabs/kirari/stream` with `applyPatch(tokens, patch)`.
+
+## License
+
+[MIT](https://github.com/vortexkit/kirari/blob/main/packages/react/LICENSE) © 2026 [Ugi](https://ugi.dev)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vortexlabs/kirari-react",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Kirari syntax highlighting as React elements.",
   "keywords": [
     "react",
@@ -10,7 +10,7 @@
   ],
   "author": "Ugi (https://ugi.dev)",
   "license": "MIT",
-  "homepage": "https://kirari.vortex.design",
+  "homepage": "https://kirari.sh",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vortexkit/kirari.git",
@@ -55,7 +55,7 @@
     "@happy-dom/global-registrator": "^20.14.6",
     "@types/react": "^19.3.0",
     "@types/react-dom": "^19.3.0",
-    "@vortexlabs/kirari": "1.0.0",
+    "@vortexlabs/kirari": "1.0.1",
     "react": "^19.3.1",
     "react-dom": "^19.3.1"
   },