update Readme (#28)

airxjs · May 26, 2024 · 3508924 · 3508924
1 parent 380ad4a
commit 3508924
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README_CN.md b/README_CN.md
@@ -71,6 +71,14 @@ app.mount(document.getElementById('app'));
 
 创建一个应用实例。
 
+```ts
+interface AirxApp {
+  mount: (container: HTMLElement) => AirxApp
+}
+
+function createApp(element: AirxElement<any> | AirxComponent): AirxApp
+```
+
 ### provide
 
 ```ts
@@ -105,6 +113,10 @@ function onUnmounted(listener: UnmountedListener): void
 
 注册 DOM 卸载回调，必须直接或间接在组件内部同步调用。
 
+## React 开发者注意
+
+- Css 属性没有任何隐式大小写转换（与 HTML 规范保持一致）
+
 ## 许可证
 
 该项目使用 MIT 许可证。详细信息请参阅 [LICENSE](LICENSE) 文件。

diff --git a/source/index.ts b/source/index.ts
@@ -22,8 +22,11 @@ export {
 } from './render'
 
 export interface AirxApp {
-  plugin: (...plugins: Plugin[]) => AirxApp
   mount: (container: HTMLElement) => AirxApp
+
+  /** @deprecated WIP */
+  plugin: (...plugins: Plugin[]) => AirxApp
+  /** @deprecated WIP */
   renderToHTML: () => Promise<string>
 }