@hellixit/hellixitboard 0.1.1 → 0.1.2

package/README.md

@@ -7,13 +7,11 @@
 Install the package together with its React peer dependencies.
 
 ```bash
-npm install react react-dom @excalidraw/hellixitboard
+npm install react react-dom @hellixit/hellixitboard
 # or
-yarn add react react-dom @excalidraw/hellixitboard
+yarn add react react-dom @hellixit/hellixitboard
 ```
 
-> **Note**: If you want to try unreleased changes, use `@excalidraw/hellixitboard@next`.
-
 ## Quick start
 
 The minimum working setup has two easy-to-miss requirements:
@@ -21,14 +19,14 @@ The minimum working setup has two easy-to-miss requirements:
 1. Import the package CSS:
 
 ```ts
-import "@excalidraw/hellixitboard/index.css";
+import "@hellixit/hellixitboard/index.css";
 ```
 
 2. Render Hellixitboard inside a container with a non-zero height.
 
 ```tsx
-import { Hellixitboard } from "@excalidraw/hellixitboard";
-import "@excalidraw/hellixitboard/index.css";
+import { Hellixitboard } from "@hellixit/hellixitboard";
+import "@hellixit/hellixitboard/index.css";
 
 export default function App() {
   return (
@@ -49,8 +47,8 @@ Hellixitboard should be rendered on the client. In SSR frameworks such as Next.j
 // app/components/HellixitboardClient.tsx
 "use client";
 
-import { Hellixitboard } from "@excalidraw/hellixitboard";
-import "@excalidraw/hellixitboard/index.css";
+import { Hellixitboard } from "@hellixit/hellixitboard";
+import "@hellixit/hellixitboard/index.css";
 
 export default function HellixitboardClient() {
   return (
@@ -75,11 +73,6 @@ export default function Page() {
 }
 ```
 
-See the local examples for complete setups:
-
-- [examples/with-nextjs](https://github.com/hellixitboard/hellixitboard/tree/master/examples/with-nextjs)
-- [examples/with-script-in-browser](https://github.com/hellixitboard/hellixitboard/tree/master/examples/with-script-in-browser)
-
 ## LLM / agent tips
 
 If an LLM or coding agent is setting up Hellixitboard, these shortcuts usually save more time than re-prompting:
@@ -87,37 +80,14 @@ If an LLM or coding agent is setting up Hellixitboard, these shortcuts usually s
 - Start with a plain `<Hellixitboard />` in a `100vh` container. Add refs, `initialData`, persistence, or custom UI only after the base embed works.
 - If the canvas is blank, check the CSS import and parent height first. Those are the two most common integration failures.
 - In Next.js or other SSR frameworks, assume client-only rendering first. Use `"use client"` and `dynamic(..., { ssr: false })` before debugging hydration or `window is not defined` errors.
-- If imports or entrypoints are unclear, inspect `node_modules/@excalidraw/hellixitboard/package.json`. The installed package exports are the source of truth.
+- If imports or entrypoints are unclear, inspect `node_modules/@hellixit/hellixitboard/package.json`. The installed package exports are the source of truth.
 - Do not set `window.HELLIXITBOARD_ASSET_PATH` unless you are intentionally self-hosting fonts/assets.
-- When docs and generated code drift, copy the nearest working example from this repo, especially `examples/with-nextjs` or `examples/with-script-in-browser`.
-
-## Migrating to `@excalidraw/hellixitboard@0.18.x`
-
-Version `0.18.x` removes the old `types/`-prefixed deep import paths. If you were importing types from `@excalidraw/hellixitboard/types/...`, switch to the new type-only subpaths below.
-
-| Old path | New path |
-| --- | --- |
-| `@excalidraw/hellixitboard/types/data/transform.js` | `@excalidraw/hellixitboard/element/transform` |
-| `@excalidraw/hellixitboard/types/data/types.js` | `@excalidraw/hellixitboard/data/types` |
-| `@excalidraw/hellixitboard/types/element/types.js` | `@excalidraw/hellixitboard/element/types` |
-| `@excalidraw/hellixitboard/types/utility-types.js` | `@excalidraw/hellixitboard/common/utility-types` |
-| `@excalidraw/hellixitboard/types/types.js` | `@excalidraw/hellixitboard/types` |
-
-Drop the `.js` extension. The new package `exports` map resolves these paths without it.
-
-These deep subpaths are for `import type` only. Runtime imports should come from the package root, plus `@excalidraw/hellixitboard/index.css` for styles.
-
-For example:
-
-```ts
-import { exportToSvg } from "@excalidraw/hellixitboard";
-```
 
 ## Self-hosting fonts
 
-By default, Hellixitboard downloads the fonts it needs from the [CDN](https://esm.run/@excalidraw/hellixitboard/dist/prod).
+By default, Hellixitboard downloads the fonts it needs from the CDN.
 
-For self-hosting, copy the contents of `node_modules/@excalidraw/hellixitboard/dist/prod/fonts` into the path where your app serves static assets, for example `public/`. Then set `window.HELLIXITBOARD_ASSET_PATH` to that same path:
+For self-hosting, copy the contents of `node_modules/@hellixit/hellixitboard/dist/prod/fonts` into the path where your app serves static assets, for example `public/`. Then set `window.HELLIXITBOARD_ASSET_PATH` to that same path:
 
 ```html
 <script>
@@ -127,16 +97,4 @@ For self-hosting, copy the contents of `node_modules/@excalidraw/hellixitboard/d
 
 ## Demo
 
-Try the [CodeSandbox example](https://codesandbox.io/p/sandbox/github/hellixitboard/hellixitboard/tree/master/examples/with-script-in-browser).
-
-## Integration
-
-Read the [integration docs](https://docs.excalidraw.com/docs/@excalidraw/hellixitboard/integration).
-
-## API
-
-Read the [API docs](https://docs.excalidraw.com/docs/@excalidraw/hellixitboard/api).
-
-## Contributing
-
-Read the [contributing docs](https://docs.excalidraw.com/docs/@excalidraw/hellixitboard/contributing).
+Try the live demo at [board.hellixit.cloud](https://board.hellixit.cloud).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hellixit/hellixitboard",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "types": "./dist/types/hellixitboard/index.d.ts",
   "main": "./dist/prod/index.js",