summaryrefslogtreecommitdiff
path: root/ext/webidl
diff options
context:
space:
mode:
Diffstat (limited to 'ext/webidl')
-rw-r--r--ext/webidl/README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/ext/webidl/README.md b/ext/webidl/README.md
index cc4ccc6e9..0b52c6fbd 100644
--- a/ext/webidl/README.md
+++ b/ext/webidl/README.md
@@ -1,6 +1,24 @@
# deno_webidl
-This crate implements WebIDL for Deno. It consists of infrastructure to do ECMA
--> WebIDL conversions.
+**This crate implements WebIDL for Deno. It consists of infrastructure to do
+ECMA -> WebIDL conversions.**
Spec: https://webidl.spec.whatwg.org/
+
+## Usage Example
+
+From javascript, include the extension's source, and assign the following to the
+global scope:
+
+```javascript
+import * as webidl from "ext:deno_webidl/00_webidl.js";
+Object.defineProperty(globalThis, webidl.brand, {
+ value: webidl.brand,
+ enumerable: false,
+ configurable: true,
+ writable: true,
+});
+```
+
+Then from rust, provide `init_webidl::init_webidl::init_ops_and_esm()` in the
+`extensions` field of your `RuntimeOptions`