Add a usage section to readme

codemirror · Dec 30, 2024 · 39585df · 39585df
1 parent 10335e5
commit 39585df
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,19 @@ we have a [code of
 conduct](http://contributor-covenant.org/version/1/1/0/) that applies
 to communication around the project.
 
+## Usage
+
+```javascript
+import {EditorView, basicSetup} from "codemirror"
+import {html} from "@codemirror/lang-html"
+
+const view = new EditorView({
+  parent: document.body,
+  doc: `<!doctype html>\n<title>HTML</title>`,
+  extensions: [basicSetup, html()]
+})
+```
+
 ## API Reference
 
 <dl>

diff --git a/src/README.md b/src/README.md
@@ -19,6 +19,19 @@ we have a [code of
 conduct](http://contributor-covenant.org/version/1/1/0/) that applies
 to communication around the project.
 
+## Usage
+
+```javascript
+import {EditorView, basicSetup} from "codemirror"
+import {html} from "@codemirror/lang-html"
+
+const view = new EditorView({
+  parent: document.body,
+  doc: `<!doctype html>\n<title>HTML</title>`,
+  extensions: [basicSetup, html()]
+})
+```
+
 ## API Reference
 
 @html