From b994686c0958af1dc782b406c65cdcad0d645316 Mon Sep 17 00:00:00 2001 From: Marijn Haverbeke Date: Mon, 30 Dec 2024 19:54:52 +0100 Subject: [PATCH] Add a usage section to readme --- README.md | 13 +++++++++++++ src/README.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index cce4676..0c10df7 100644 --- 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 {javascript} from "@codemirror/lang-javascript" + +const view = new EditorView({ + parent: document.body, + doc: `console.log("Hello world")`, + extensions: [basicSetup, javascript()] +}) +``` + ## API Reference
diff --git a/src/README.md b/src/README.md index 8c3d26f..a52b346 100644 --- 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 {javascript} from "@codemirror/lang-javascript" + +const view = new EditorView({ + parent: document.body, + doc: `console.log("Hello world")`, + extensions: [basicSetup, javascript()] +}) +``` + ## API Reference @javascript