simple-ime 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nieyuyao0826@hotmail.com
+
+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

@@ -0,0 +1,81 @@
+# Simple Ime
+An simple browser tool to use Chinese Pinyin Input Method (IME).
+
+<img src="./public/demo.png" width="240" />
+
+# Install
+
+> npm install simple-ime
+
+# Usage
+
+```js
+import { createSimpleIme } from 'simple-ime'
+
+const ime = createSimpleIme()
+
+// turn on ime
+ime.turnOn()
+
+// turn off ime
+ime.turnOff()
+```
+
+# APIs
+
+## createSimpleIme
+
+Create ime instance.
+
+`function createSimpleIme(): SimpleImeInstance`
+
+## SimpleImeInstance
+
+### Properties:
+
+#### version
+
+Version of ime.
+
+`version: string`
+
+### Methods:
+
+#### turnOn
+
+Turn on the ime.
+
+`function turnOn(): void`
+
+#### turnOff
+
+Turn off the ime.
+
+`function turnOff(): void`
+
+#### toggleOnOff
+
+Toggle the ime.
+
+`function toggleOnOff(): void`
+
+#### dispose
+
+Destroy the ime instance.
+
+`function dispose(): void`
+
+# Development
+
+Run `npm run dev` and then open browser.
+
+# Build
+
+```shell
+npm run build
+```
+
+# Credits
+
+- The frontend part of the implementation is heavily inspired by [CloudInput](https://github.com/mzhangdev/CloudInput).
+- Thanks to [web-pinyin-ime](https://github.com/dongyuwei/web-pinyin-ime) for algorithm of generating candidate words.