@aicayzer/inkkit 0.0.17 → 0.1.0

package/NOTICE

@@ -21,5 +21,7 @@ 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.
 
-Milkdown and other runtime dependencies retain their own licences. They are
-installed as dependencies.
+The published package bundles Milkdown, ProseMirror and other packages. Each
+keeps its own licence; dist/THIRD-PARTY-NOTICES.txt in the package lists them
+with their licence texts. Mermaid is installed as a dependency and keeps its
+own licence.

package/README.md

@@ -15,6 +15,12 @@ A Markdown editor for the web and for apps that host a web view. It edits format
 npm install @aicayzer/inkkit
 ```
 
+An app that does not render diagrams can import from `@aicayzer/inkkit/core` instead. That entry leaves Mermaid out of the app's bundle and keeps diagrams as editable source. See [Builds without diagrams](https://github.com/aicayzer/inkkit/blob/main/docs/api.md#builds-without-diagrams).
+
+## Supported engines
+
+InkKit supports Safari and `WKWebView` 17.5 or later (iOS 17.5, macOS 14.5), Chrome and Edge 123 or later, and Firefox 125 or later. The host page must declare UTF-8. See [Supported engines](https://github.com/aicayzer/inkkit/blob/main/docs/integration.md#supported-engines) for the APIs behind these versions.
+
 ## Use
 
 ```ts
@@ -22,8 +28,8 @@ import { InkKitEditor } from '@aicayzer/inkkit'
 import '@aicayzer/inkkit/style.css'
 
 const editor = await InkKitEditor.mount(document.getElementById('editor')!, {
-  changed(markdown, generation) {},
-  stateChanged(state) {},
+  changed({ generation, revision, text }) {},
+  commandStateChanged({ caret }) {},
   openLink(href) {},
   copy(text) {},
 })
@@ -45,10 +51,10 @@ const { text } = editor.snapshot(1)
 
 ## Learn more
 
-- [Supported syntax](docs/supported-syntax.md)
-- [Integration guide](docs/integration.md)
-- [API reference](docs/api.md)
-- [All documentation](docs/README.md)
+- [Supported syntax](https://github.com/aicayzer/inkkit/blob/main/docs/supported-syntax.md)
+- [Integration guide](https://github.com/aicayzer/inkkit/blob/main/docs/integration.md)
+- [API reference](https://github.com/aicayzer/inkkit/blob/main/docs/api.md)
+- [All documentation](https://github.com/aicayzer/inkkit/blob/main/docs/README.md)
 
 ## License