diff --git a/README.md b/README.md index 8ac6991..07c177d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,9 @@ -# JavaScript/TypeScript Client SDK for OpenIM 👨‍💻💬 +# Node/Electron Client SDK for OpenIM 👨‍💻💬 Use this SDK to add instant messaging capabilities to your application. By connecting to a self-hosted [OpenIM](https://www.openim.online/) server, you can quickly integrate instant messaging capabilities into your app with just a few lines of code. The underlying SDK core is implemented in [OpenIM SDK Core](https://github.com/openimsdk/openim-sdk-core). Using the [WebAssembly](https://webassembly.org/) support provided by Go language, it can be compiled into wasm for web integration. The web interacts with the [OpenIM SDK Core](https://github.com/openimsdk/openim-sdk-core) through JSON, and the SDK exposes a re-encapsulated API for easy usage. In terms of data storage, JavaScript handles the logic of the SQL layer by virtualizing SQLite and storing it in IndexedDB using [sql.js](https://sql.js.org/). - - - ## Documentation 📚 Visit [https://doc.rentsoft.cn/](https://doc.rentsoft.cn/) for detailed documentation and guides. @@ -18,76 +15,9 @@ For the SDK reference, see [https://doc.rentsoft.cn/sdks/quickstart/browser](htt ### Adding Dependencies ```shell -npm install open-im-sdk-wasm --save +npm install open-im-sdk-node --save ``` -### Obtaining Required Static Resources for WASM - -Follow these steps to obtain the static resources required for WebAssembly (WASM): - -1. Locate the `open-im-sdk-wasm` subdirectory in the `node_modules` directory of your project. Copy all the files in the `assets` folder to your project's public resource directory. - - The files to be copied are: - - - `openIM.wasm` - - `sql-wasm.wasm` - - `wasm_exec.js` - -2. After copying the files, import the `wasm_exec.js` file in your `index.html` file using a `