From d716b7fd83f49fa7825b36cf889760152348468d Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Thu, 28 Mar 2024 14:58:55 -0400 Subject: [PATCH] Improve readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 031771d..c36ca8e 100644 --- a/README.md +++ b/README.md @@ -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(); @@ -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.