doc: update README

This commit is contained in:
evanp committed 2026-11-06 13:39:14 -05:00
1 parent 55e2764480
commit f295cb8535
2 files changed
+36 -6

No files matched your search

+8 -1
View File
@@ -10,6 +10,12 @@ and this project adheres to
## [Unreleased] ## [Unreleased]
## [0.2.1] - 2026-11-06
### Fixed
- Correct instructions for setting the API key in README.
## [0.2.0] - 2026-11-06 ## [0.2.0] - 2026-11-06
### Added ### Added
@@ -58,6 +64,7 @@ First release usable for chat.
Initial development release. Not functional 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.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 [0.1.0]: https://git.inference.coop/evanp/inference-coop-copilot/releases/tag/v0.1.0
+28 -5
View File
@@ -1,14 +1,37 @@
# Inference Coop (unofficial) # Inference Coop for Copilot Chat (unofficial)
Community-built model provider for [inference.coop](https://inference.coop), Community-built model provider for [inference.coop](https://inference.coop),
usable in GitHub Copilot Chat. Not affiliated with or endorsed by the usable in GitHub Copilot Chat. Not affiliated with or endorsed by the
Inference Cooperative. 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 ## Setup
1. Set `inferenceCoop.apiKey` in your settings to your co-op API key. 1. Run **Inference Coop: Set API Key** from the Command Palette and paste
2. Open Copilot Chat and pick an `inference-coop/…` model. 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).