Skip to content

Commit

Permalink
Update README.md (#3174)
Browse files Browse the repository at this point in the history
  • Loading branch information
TallTed committed May 12, 2023
1 parent ce03d2a commit cb107f7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/cm6-graphql/README.md
Expand Up @@ -5,7 +5,7 @@
[![License](https://img.shields.io/npm/l/cm6-graphql.svg?style=flat-square)](LICENSE)
[Discord Channel](https://discord.gg/cffZwk8NJW)

Provides CodeMirror 6 extension with a parser mode for GraphQL along with a
Provides CodeMirror 6 extension with a parser mode for GraphQL along with
autocomplete and linting powered by your GraphQL Schema.

### Getting Started
Expand All @@ -15,8 +15,8 @@ npm install --save cm6-graphql
```

[CodeMirror 6](https://codemirror.net/) customization is done through
[extensions](https://codemirror.net/docs/guide/#extension). This package an
extension that customizes codemirror 6 for GraphQL.
[extensions](https://codemirror.net/docs/guide/#extension). This package is
an extension that customizes CodeMirror 6 for GraphQL.

```js
import { basicSetup, EditorView } from 'codemirror';
Expand All @@ -31,16 +31,16 @@ const view = new EditorView({
});
```

Note: You have to provide a theme to CodeMirror 6 for the styling you want. You
_**Note:** You have to provide a theme to CodeMirror 6 for the styling you want. You
can take a look at
[this example](https://github.com/graphql/graphiql/blob/main/examples/cm6-graphql-parcel/src/index.ts)
or see the CodeMirror 6
[documentation examples](https://codemirror.net/examples/styling/) for more
details.
details._

### Updating schema

If you need to update the GraphQL schema used in the editor dynamically, you can
If you need to dynamically update the GraphQL schema used in the editor, you can
call `updateSchema` with the CodeMirror `EditorView` instance and the new schema

```js
Expand Down

0 comments on commit cb107f7

Please sign in to comment.