Skip to content

Commit 1a37894

Browse files
authoredAug 16, 2024
Merge pull request #1 from copilot-extensions/improve-readme
Improve README
2 parents 9c8400d + e4da7be commit 1a37894

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed
 

‎README.md

+23-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# @gh-models Copilot Extension
22

3+
This is a [GitHub Copilot Extension](https://docs.github.com/en/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat) that provides a way to interact with [GitHub Models](https://github.blog/news-insights/product-news/introducing-github-models/), directly in Copilot Chat.
4+
5+
> [!NOTE]
6+
> To use Copilot Extensions, you must be enrolled in the limited public beta.
7+
>
8+
> All enrolled users with a GitHub Copilot Individual subscription can use Copilot Extensions.
9+
>
10+
> For enrolled organizations or enterprises with a Copilot Business or Copilot Enterprise subscription, organization owners and enterprise administrators can grant access to Copilot Extensions.
11+
12+
## What it can do
13+
14+
You can ask it things like "what models are available?" or "which model should I use for my use-case?". You can also ask it to execute a basic prompt using a particular model.
15+
16+
| Description | Image |
17+
| --- |--- |
18+
| User asking `@gh-models` for a recommended model that is low-cost and supports function calling | ![User asking @gh-models for a recommended model that is low-cost and supports function calling](https://github.com/user-attachments/assets/aed29aa3-2056-44c5-8c7b-e8ef7ffa3301) |
19+
| Dialogue with the Extension, asking for an OpenAI model | ![Dialogue with the Extension, asking for an OpenAI model](https://github.com/user-attachments/assets/f08b23a9-7f2c-4da7-b764-7220dcda9408) |
20+
| User executing a basic prompt using the model that the extension recommended | ![User executing a basic prompt using the model that the extension recommended](https://github.com/user-attachments/assets/795dd669-aea2-4b88-9c27-0836008c28a4) |
21+
| In VS Code, explain code using a specific model | <img width="838" alt="image" src="https://github.com/user-attachments/assets/c019ed37-5494-4cb6-9e21-82ecf3235dcc"> |
22+
323
## Development
424

525
Install dependencies:
@@ -8,15 +28,14 @@ Install dependencies:
828
npm install
929
```
1030

11-
To run:
12-
31+
To run in development mode:
1332

1433
```bash
1534
npm run dev
1635
```
1736

18-
To build:
37+
To build and run in production mode:
1938

2039
```bash
21-
npm run build
40+
npm run build && npm start
2241
```

0 commit comments

Comments
 (0)
Failed to load comments.