Skip to content

docs(README): introduction by @d1m1tr10s #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 4, 2024
Merged

docs(README): introduction by @d1m1tr10s #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
328c7cf
docs(README): introduction by @d1m1tr10s
gr2m Sep 4, 2024
6c0121e
some changes by @gr2m
gr2m Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,21 @@

> SDK for building GitHub Copilot Extensions

⚠️ **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.
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.

We consider this SDK alpha software in terms of API stability, but we adhere to semantic-versioning, so it's safe to use today.

## Key features

- Request payload verification
- Payload parsing
- Response building

## Benefits

- Handles security and response formatting requirements
- Provides utilities for common extension tasks
- Streamlines the development process

## Usage

Expand Down