From 64023905c5e02f546d0a11b17d7f94fd57bfb6c7 Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Mon, 25 Mar 2024 16:51:52 -0400 Subject: [PATCH] Update README --- README.md | 12 ++++++++++++ demo/index.html | 5 ++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a230c91..6c55781 100644 --- a/README.md +++ b/README.md @@ -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(); +``` diff --git a/demo/index.html b/demo/index.html index d137d2a..fc104b3 100644 --- a/demo/index.html +++ b/demo/index.html @@ -14,7 +14,10 @@

>

by val.town

-

⚠️ Hella experimental, very unofficial

+

+ ⚠️ Hella experimental, very unofficial. Type in the box and it'll give + you AI autocompletions powered by Codeium. +

TypeScript environment in a web worker