From f295cb8535b56f39d3871aa59604a670c090b316 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Fri, 6 Nov 2026 13:39:14 -0500 Subject: [PATCH] doc: update README --- CHANGELOG.md | 9 ++++++++- README.md | 33 ++++++++++++++++++++++++++++----- 2 files changed, 36 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91878aa..3ed8c0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,12 @@ and this project adheres to ## [Unreleased] +## [0.2.1] - 2026-11-06 + +### Fixed + +- Correct instructions for setting the API key in README. + ## [0.2.0] - 2026-11-06 ### Added @@ -58,6 +64,7 @@ First release usable for chat. Initial development release. Not functional for chat. -[Unreleased]: https://git.inference.coop/evanp/inference-coop-copilot/compare/v0.2.0...HEAD +[Unreleased]: https://git.inference.coop/evanp/inference-coop-copilot/compare/v0.2.1...HEAD +[0.2.1]: https://git.inference.coop/evanp/inference-coop-copilot/compare/v0.2.0...v0.2.1 [0.2.0]: https://git.inference.coop/evanp/inference-coop-copilot/compare/v0.1.0...v0.2.0 [0.1.0]: https://git.inference.coop/evanp/inference-coop-copilot/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 2caab7e..1687143 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,37 @@ -# Inference Coop (unofficial) +# Inference Coop for Copilot Chat (unofficial) Community-built model provider for [inference.coop](https://inference.coop), usable in GitHub Copilot Chat. Not affiliated with or endorsed by the Inference Cooperative. +## Requirements + +- VS Code 1.145 or newer +- GitHub Copilot Chat, installed and signed in +- A co-op membership and API key + +Copilot Business/Enterprise: your administrator must leave "Bring Your Own +Language Model Key" enabled, or these models will not appear. + ## Setup -1. Set `inferenceCoop.apiKey` in your settings to your co-op API key. -2. Open Copilot Chat and pick an `inference-coop/…` model. +1. Run **Inference Coop: Set API Key** from the Command Palette and paste + your co-op key. It is stored in VS Code's secret storage, not in settings. +2. Open Copilot Chat, click the model name, and pick an `inference-coop/…` + model. Tool calling works, so agent mode is usable. -## Status +To use a different gateway, set `inferenceCoop.baseUrl`. To sign out, run +**Inference Coop: Sign Out**. -Early development. Text chat only so far; tool calling is not implemented. +## Limitations + +- No image input; models are advertised as text-and-tools only. +- Token counts are estimated rather than computed with a real tokenizer, so + context budgeting is approximate. +- No inline code completions. Copilot does not support third-party providers + for completions; this extension only adds chat models. +- Unofficial client. Report extension bugs here, not to the co-op. + +## License + +Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).