From 328c7cf09a6d550080bc0287e81f923c09c8c6e4 Mon Sep 17 00:00:00 2001 From: Gregor Martynus <39992+gr2m@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:29:50 -0700 Subject: [PATCH 1/2] docs(README): introduction by @d1m1tr10s --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 99d64a7..22d49d5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,22 @@ > 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 verification +- Response formatting for Copilot Chat +- Payload parsing +- GitHub API interactions + +## Benefits + +- Handles security and formatting requirements +- Provides utilities for common extension tasks +- Streamlines the development process ## Usage From 6c0121e597ba629fefcf973a2d13c770453ba9a0 Mon Sep 17 00:00:00 2001 From: Gregor Martynus <39992+gr2m@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:31:43 -0700 Subject: [PATCH 2/2] some changes by @gr2m --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22d49d5..66ec0d7 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,13 @@ We consider this SDK alpha software in terms of API stability, but we adhere to ## Key features -- Request verification -- Response formatting for Copilot Chat +- Request payload verification - Payload parsing -- GitHub API interactions +- Response building ## Benefits -- Handles security and formatting requirements +- Handles security and response formatting requirements - Provides utilities for common extension tasks - Streamlines the development process