@p10node/office-engine 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 p10node
+
+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,66 @@
-# Temporary Holding Version
+# @p10node/office-engine
 
-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.
+View + edit **DOCX / XLSX / PPTX** directly in the browser. Loads progressively like Google Docs, handles heavy files, one-line React embed, saves back to the original format.
+
+**[Live demo](https://p10node.github.io/office-engine/demo/)**: samples, heavy files (300k-row sheet, 305-slide deck), drag & drop your own file, edit and download.
+
+| DOCX                                      | XLSX                                      | PPTX                                      |
+|-------------------------------------------|-------------------------------------------|-------------------------------------------|
+| ![DOCX editor](docs/screenshots/docx.png) | ![XLSX editor](docs/screenshots/xlsx.png) | ![PPTX editor](docs/screenshots/pptx.png) |
+
+## Features
+
+- **Progressive loading**: lazy ZIP, HTTP Range requests, streaming XML parser in a Web Worker → UI never blocks
+- **Virtualized views**: only visible pages, cells and slides render
+- **Editing** with a Google Docs-style toolbar: DOCX text, styles, lists, images, tables; XLSX cells, formulas (134 functions), formats, borders, rows/columns, sheets; PPTX text, shapes, images, slides, slideshow
+- **Fast save**: only edited parts are regenerated, everything else keeps its original bytes
+- **Real-time collaboration**: live edits, avatars, collaborators' cursors, offline edits sync on reconnect
+- **Embed anywhere**: React component, hook, vanilla `mount()`, `<office-viewer>` web component, single `<script>` file
+
+Full list, format coverage and limitations: [Features](docs/features.md).
+
+| File                     | Size    | First paint | Fully loaded      |
+|--------------------------|---------|-------------|-------------------|
+| DOCX 20k paragraphs      | 1.2 MB  | ~180 ms     | 2073 pages in ~2s |
+| XLSX 300k rows × 12 cols | 24.8 MB | ~330 ms     | ~2s               |
+| PPTX 305 slides          | 0.3 MB  | ~110 ms     | on-demand         |
+
+Measured in headless Chromium on Apple M-series.
+
+## Install
+
+```bash
+bun add @p10node/office-engine   # peer: react >= 18, react-dom >= 18
+```
+
+## Usage
+
+```tsx
+import { DocViewer } from '@p10node/office-engine'
+
+<DocViewer src={file} style={{ height: 600 }} />                 // File | Blob | ArrayBuffer | Uint8Array
+<DocViewer src="https://cdn.example.com/report.xlsx" />          // URL → Range requests
+<DocViewer src={file} editable onSave={(blob, name) => upload(blob, name)} />
+```
+
+CSS is auto-injected. Container must have a height.
+
+Without React:
+
+```html
+<script src="office-engine.embed.js"></script>   <!-- dist/, bundles React + worker -->
+<office-viewer src="/files/report.docx" style="height:600px"></office-viewer>
+```
+
+## Docs
+
+Also online at [p10node.github.io/office-engine](https://p10node.github.io/office-engine/).
+
+- [Features](docs/features.md): format coverage, editing, saving, limitations
+- [API](docs/api.md): props, custom views, `mount()`, `<office-viewer>`, core API, CSP
+- [Real-time collaboration](docs/collaboration.md)
+- [Development](docs/development.md): playground, architecture, demo deploy, release
+
+## License
+
+[MIT](LICENSE) © p10node