Skip to content

Update README structure and add samples folder #85

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
patniko merged 1 commit into from
Jan 22, 2026
Merged

Update README structure and add samples folder #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,21 @@ The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-

## Available SDKs

| SDK | Location | Installation |
| ------------------------ | --------------------------------- | ----------------------------------------- |
| **Node.js / TypeScript** | [`./nodejs/`](./nodejs/README.md) | `npm install @github/copilot-sdk` |
| **Python** | [`./python/`](./python/README.md) | `pip install github-copilot-sdk` |
| **Go** | [`./go/`](./go/README.md) | `go get github.com/github/copilot-sdk/go` |
| **.NET** | [`./dotnet/`](./dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` |
| SDK | Location | Installation |
| ------------------------ | ------------------------------------------- | ----------------------------------------- |
| **Node.js / TypeScript** | [`cookbook/nodejs/`](./cookbook/nodejs/README.md) | `npm install @github/copilot-sdk` |
| **Python** | [`cookbook/python/`](./cookbook/python/README.md) | `pip install github-copilot-sdk` |
| **Go** | [`cookbook/go/`](./cookbook/go/README.md) | `go get github.com/github/copilot-sdk/go` |
| **.NET** | [`cookbook/dotnet/`](./cookbook/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` |

See the individual SDK READMEs for installation, usage examples, and API reference.

## Getting Started

For a complete walkthrough, see the **[Getting Started Guide](./docs/getting-started.md)**.

Quick steps:

1. **Install the Copilot CLI:**

Follow the [Copilot CLI installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) to install the CLI, or ensure `copilot` is available in your PATH.
Expand All @@ -43,9 +47,11 @@ Your Application

The SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see individual SDK docs for details.

## Examples
## Quick Links

Check out the [examples folder](./examples/README.md) for sample projects and videos.
- **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running
- **[Cookbook](./cookbook/README.md)** – Practical recipes for common tasks across all languages
- **[Samples](./samples/README.md)** – Video walkthroughs and sample projects

## Contributing

Expand Down
26 changes: 0 additions & 26 deletions cookbook/demos/README.md
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions cookbook/examples/README.md
View file
Open in desktop

This file was deleted.

13 changes: 13 additions & 0 deletions samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Samples

## Videos

| Title | Description | Link |
|-------|-------------|------|
| AI Powered YouTube Content Generator | Build an AI-powered tool to generate YouTube content | [Watch](https://youtu.be/6GcupNzH678) |

<!-- Add videos above -->

## Contributing

Have a sample to share? Open a PR to add it to this list.
Loading