excel-collab 0.0.8 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.1.0](https://github.com/nusr/excel/compare/v0.0.8...v0.1.0) (2025-01-27)
+
+### Features
+
+* init model ([6b0d06d](https://github.com/nusr/excel/commit/6b0d06d4e45f113c4e266b561837829ad89f290b))
+
+### Bug Fixes
+
+* simplify the import of worker ([77982de](https://github.com/nusr/excel/commit/77982de7b286ab3ffca0711120aed95e3d3b9421))
+* update dep ([dc9aa8f](https://github.com/nusr/excel/commit/dc9aa8ff30567f377d4e3ed1e514ac4adf026bbe))
+
 ## [0.0.8](https://github.com/nusr/excel/compare/v0.0.7...v0.0.8) (2025-01-14)
 
 ### Features

package/README.md

@@ -1,4 +1,4 @@
-# 🌐 Online Collaboration Excel
+# Online Collaboration Excel
 
 [![CI](https://github.com/nusr/excel/actions/workflows/main.yml/badge.svg)](https://github.com/nusr/excel/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/nusr/excel/branch/main/graph/badge.svg?token=ZOC8RHD3Z1)](https://codecov.io/gh/nusr/excel)
@@ -11,19 +11,67 @@ English | [中文](./README_zh.md)
 
 ![Demo](./scripts/demo.gif)
 
-## 🚀 Installation
+## Installation
 
 ```bash
 npm i --save excel-collab
 ```
 
-## 📚 Examples
+## Quick Start
+
+1. Create a React app
+
+```bash
+npm create vite@latest my-app -- --template react-ts
+cd my-app
+npm i
+```
+
+2. Install the Required Libraries
+
+```bash
+npm i --save excel-collab yjs
+```
+
+3. Modify the Main File
+
+```ts src/main.tsx
+// src/main.tsx
+import { createRoot } from 'react-dom/client';
+import { StrictMode } from 'react';
+import { initController, StateContext, Excel } from 'excel-collab';
+import Worker from 'excel-collab/worker?worker';
+import 'excel-collab/style.css';
+import * as Y from 'yjs';
+
+const controller = initController({
+  worker: new Worker(),
+  doc: new Y.Doc(),
+});
+
+createRoot(document.getElementById('root')!).render(
+  <StrictMode>
+    <div style={{ height: '100vh' }}>
+      <StateContext value={{ controller }}>
+        <Excel />
+      </StateContext>
+    </div>
+  </StrictMode>,
+);
+```
+
+4. Start the app
+
+```bash
+npm run dev
+```
+
+## Examples
 
 - [Simple Example](https://stackblitz.com/edit/nusr-excel-simple)
 - [Custom Example](https://stackblitz.com/edit/nusr-excel-custom)
-- [Collaboration Example](https://stackblitz.com/edit/nusr-excel-collaboration)
 
-## 🛠️ Developing
+## Collaboration Example
 
 ```bash
 git clone https://github.com/nusr/excel.git
@@ -31,12 +79,13 @@ cd excel
 
 npm i -g pnpm
 pnpm i
+
 cd demo/frontend && pnpm i && cd -
 cd demo/backend && pnpm i && cd -
 npm run dev
 ```
 
-## ✨ Supported Features
+## Supported Features
 
 - [x] Online Collaboration
 - [x] Create File