diff --git a/.changeset/bumpy-colts-double.md b/.changeset/bumpy-colts-double.md new file mode 100644 index 0000000000..e3affc39a0 --- /dev/null +++ b/.changeset/bumpy-colts-double.md @@ -0,0 +1,5 @@ +--- +"@lynx-js/web-core": patch +--- + +chore: update readme diff --git a/packages/web-platform/web-core/README.md b/packages/web-platform/web-core/README.md index 7e2e206191..6a08f24fcf 100644 --- a/packages/web-platform/web-core/README.md +++ b/packages/web-platform/web-core/README.md @@ -1 +1,38 @@ -# This is an internal experimental package, do not use +# @lynx-js/web-core + +Lynx3 Web Platform runtime core + +## Usage + +### use an open CDN + +#### unpkg + +```html + + +``` + +#### jsdelivr + +```html + + +``` + +### bundle with your project + +```javascript +import '@lynx-js/web-core/client'; + +document.body.innerHTML = ` + +`; +``` + +## Document + +See our website for more information.