docs: README and CHANGELOG

This commit is contained in:
evanp committed 2026-11-06 12:43:42 -05:00
1 parent 52e29529c3
commit 120e480b2d
3 files changed
+37 -71

No files matched your search

+9 -66
View File
@@ -1,71 +1,14 @@
# inference-coop-copilot README
# Inference Coop (unofficial)
This is the README for your extension "inference-coop-copilot". After writing up a brief description, we recommend including the following sections.
Community-built model provider for [inference.coop](https://inference.coop),
usable in GitHub Copilot Chat. Not affiliated with or endorsed by the
Inference Cooperative.
## Features
## Setup
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
1. Set `inferenceCoop.apiKey` in your settings to your co-op API key.
2. Open Copilot Chat and pick an `inference-coop/…` model.
For example if there is an image subfolder under your extension project workspace:
## Status
\!\[feature X\]\(images/feature-x.png\)
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
## Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
## Extension Settings
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
For example:
This extension contributes the following settings:
* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.
## Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
## Release Notes
Users appreciate release notes as you update your extension.
### 1.0.0
Initial release of ...
### 1.0.1
Fixed issue #.
### 1.1.0
Added features X, Y, and Z.
---
## Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
## Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
## For more information
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
**Enjoy!**
Early development. Text chat only so far; tool calling is not implemented.