@kerros/editor 0.0.0-stage → 0.1.0-rc.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kyösti Herrala
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @kerros/editor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The React authoring interface for Kerros projects, including floor-plan drawing, geometry editing,
+browser persistence adapters, reference images, and browser-safe CAD conversion.
+
+```sh
+npm install @kerros/editor maplibre-gl three react react-dom
+```
+
+```tsx
+import { FloorEditor, IndexedAssetRepository, LocalProjectRepository, emptyProject } from '@kerros/editor';
+import { setWorkerUrl } from 'maplibre-gl';
+import maplibreWorkerUrl from 'maplibre-gl/dist/maplibre-gl-worker.mjs?worker&url';
+import '@kerros/editor/styles.css';
+
+setWorkerUrl(maplibreWorkerUrl);
+const project = emptyProject([24.938, 60.169], 'Example building');
+const adapters = {
+  projects: new LocalProjectRepository(),
+  assets: new IndexedAssetRepository(),
+};
+
+export function App() {
+  return <FloorEditor project={project} adapters={adapters} />;
+}
+```
+
+The worker import above is for Vite. Configure the MapLibre worker with the equivalent mechanism for
+your bundler before rendering a Kerros map.
+
+Use `@kerros/editor/host` for persistence, theming, schema, and CAD conversion helpers without the
+map renderer. See the [editor reference](https://github.com/kherrala/kerros/blob/main/docs/reference/editor.md),
+[getting-started guide](https://github.com/kherrala/kerros/blob/main/docs/guide/getting-started.md), and
+[changelog](https://github.com/kherrala/kerros/blob/main/CHANGELOG.md).
+
+MIT licensed.