Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Mar 28, 2024
1 parent cb6d44c commit d716b7f
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ See the [demo source code](https://github.com/val-town/codemirror-codeium/tree/m
a reference to how it's used.

```ts
import { copilotPlugin } from "@val-town/codemirror-codeium";
import { copilotPlugin } from "@valtown/codemirror-codeium";

// This is a CodeMirror extension
copilotPlugin();
Expand All @@ -48,3 +48,12 @@ text. You can add your own style for this class. The demo uses this style:
background: #eee;
}
```

### Architecture

This makes requests against the [Codeium](https://codeium.com/) hosted product,
using their Protocol Buffer-based interface. That's what the `buf` and `connectrpc`
modules are doing - generating and using bindings to their service.

The extension is a composite of facets, decorations, state fields, and more
that are encapsulated.

0 comments on commit d716b7f

Please sign in to comment.