Skip to content

Commit df1a29f

Browse files
committed
docs(README): introduction by @D1M1TR10S
1 parent adc72d3 commit df1a29f

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,37 @@
22

33
> SDK for building GitHub Copilot Extensions
44
5+
This SDK simplifies the process of building GitHub Copilot Extensions. Building Copilot Extensions previously required manual handling of request verification, response formatting, and API interactions. This SDK simplifies these tasks, allowing you to focus on your extension's core functionality rather than building boilerplate code. Use it to integrate your tools, APIs, or data sources directly into Copilot Chat.
6+
7+
We consider this SDK alpha software in terms of API stability, but we adhere to semantic-versioning, so it's safe to use today.
8+
9+
## Key features
10+
11+
- Request verification
12+
- Response formatting for Copilot Chat
13+
- Payload parsing
14+
- GitHub API interactions
15+
16+
## Benefits
17+
18+
- Handles security and formatting requirements
19+
- Provides utilities for common extension tasks
20+
- Streamlines the development process
21+
522
⚠️ **This SDK is a preview and subject to change**. We will however adhere to [semantic versioning](https://semver.org/), so it's save to use for early experimentation. Just beware there will be breaking changes. Best to watch this repository's releases for updates.
623

24+
This SDK simplifies the process of building GitHub Copilot Extensions. Building Copilot Extensions previously required manual handling of request verification, response formatting, and API interactions. This SDK simplifies these tasks, allowing you to focus on your extension's core functionality rather than building boilerplate code. Use it to integrate your tools, APIs, or data sources directly into Copilot Chat.
25+
Key features
26+
Request verification
27+
Response formatting for Copilot Chat
28+
Payload parsing
29+
GitHub API interactions
30+
Benefits
31+
Handles security and formatting requirements
32+
Provides utilities for common extension tasks
33+
Streamlines the development process
34+
Note: This preview SDK follows semantic versioning but may have breaking changes in future updates.
35+
736
## Usage
837

938
### Verify a request

0 commit comments

Comments
 (0)