doc: update README with instructions for joining, getting an API key

This commit is contained in:
evanp committed 2026-11-08 11:47:09 -05:00
1 parent a789afbd61
commit a252f90b62
2 files changed
+33 -6

No files matched your search

+6
View File
@@ -25,6 +25,10 @@ and this project adheres to
- Changed the Marketplace category from "Other" to "AI".
- Changed the Marketplace display name from the package ID to the readable
title, "Inference Coop for Copilot Chat".
- Reworked the README: an "About the Inference Cooperative" section for
prospective members, step-by-step Setup instructions starting with
creating an API key at the dashboard (noting keys are shown only once),
and consistent use of "Inference Cooperative" as the organization name.
### Removed
@@ -32,6 +36,8 @@ and this project adheres to
ever talked to the hardcoded `https://gateway.inference.coop/v1` gateway;
keeping a configurable URL would let a modified setting redirect the
stored API key to a hostile endpoint.
- Removed the membership/API-key line from Requirements, since Setup now
walks through acquiring both.
## [0.3.0] - 2026-11-08
+27 -6
View File
@@ -4,26 +4,47 @@
Official model provider for [inference.coop](https://inference.coop), usable
in GitHub Copilot Chat. An official project of the Inference Cooperative,
maintained in the co-op's Git at
maintained in the Inference Cooperative's Git at
[code/inference-coop-copilot](https://git.inference.coop/code/inference-coop-copilot).
## About the Inference Cooperative
The Inference Cooperative is a member-owned cooperative that pools its
members' purchasing power to support privacy-preserving, renewable-energy,
and open-weights AI services. Members choose among powerful, open-weights
models — hosted in encrypted enclaves, on 100% renewable power, or built as
public goods — instead of accepting whatever Big Tech offers.
Membership is a sliding scale starting at $5 a month. Every member gets the
same $15 monthly credit for chat and API use, plus a vote in how the
Inference Cooperative is run. Credits never expire, and you can cancel any time.
To join, visit [inference.coop](https://inference.coop) and sign up. Your
membership includes access to the chat and the developer API — this
extension brings those same models into GitHub Copilot Chat.
## 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. 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/…`
1. Create an API key at
[dashboard.inference.coop/#keys-card](https://dashboard.inference.coop/#keys-card).
**The key is only shown once, right after it is created** — copy it
somewhere safe before you close the page.
2. Run **Inference Coop: Set API Key** from the Command Palette and paste
the key. It is stored in VS Code's secret storage, not in settings.
3. Open Copilot Chat, click the model name, and pick an `inference-coop/…`
model. Tool calling works, so agent mode is usable.
To sign out, run **Inference Coop: Sign Out**.
To sign out, run **Inference Coop: Sign Out**. (You can create a new key
any time and run Set API Key again — keys are not deleted when you sign
out, so revoke unused keys from the dashboard.)
## Limitations