Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed Mar 25, 2024
1 parent b141f93 commit 6402390
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,15 @@ _Very experimental and unofficial_

Copilot-like ghost text code from [modeling-app](https://github.com/KittyCAD/modeling-app)
by [Jess Frazelle](https://github.com/jessfraz) and based on [Cursor](https://cursor.sh/).

## Documentation

See the [demo source code](https://github.com/val-town/codemirror-codeium/tree/main/demo) for
a reference to how it's used.

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

// This is a CodeMirror extension
copilotPlugin();
```
5 changes: 4 additions & 1 deletion demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ <h1>
>
</h1>
<p>by <a href="https://www.val.town/">val.town</a></p>
<p>⚠️ Hella experimental, very unofficial</p>
<p>
⚠️ Hella experimental, very unofficial. Type in the box and it'll give
you AI autocompletions powered by Codeium.
</p>

<h3>TypeScript environment in a web worker</h3>
<div id="app">
Expand Down

0 comments on commit 6402390

Please sign in to comment.