Add a usage section to readme

codemirror · Dec 30, 2024 · 2e7fa06 · 2e7fa06
1 parent 24e43e6
commit 2e7fa06
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 {markdown} from "@codemirror/lang-markdown"
+
+const view = new EditorView({
+  parent: document.body,
+  doc: `*CodeMirror* Markdown \`mode\``,
+  extensions: [basicSetup, markdown()]
+})
+```
+
 ## 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 {markdown} from "@codemirror/lang-markdown"
+
+const view = new EditorView({
+  parent: document.body,
+  doc: `*CodeMirror* Markdown \`mode\``,
+  extensions: [basicSetup, markdown()]
+})
+```
+
 ## API Reference
 
 @markdown