Skip to content

Commit 85754ea

Browse files
authored
Update README structure and add samples folder (#85)
- Update README SDK paths to point to cookbook/ - Add Quick Links section with Getting Started, Cookbook, and Samples - Rename demos to samples and move to root level - Remove duplicate cookbook/examples folder - Add AI Powered YouTube Content Generator video to samples
1 parent 2005d79 commit 85754ea

File tree

4 files changed

+27
-60
lines changed

4 files changed

+27
-60
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,21 @@ The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-
1010

1111
## Available SDKs
1212

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

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

2222
## Getting Started
2323

24+
For a complete walkthrough, see the **[Getting Started Guide](./docs/getting-started.md)**.
25+
26+
Quick steps:
27+
2428
1. **Install the Copilot CLI:**
2529

2630
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.
@@ -43,9 +47,11 @@ Your Application
4347

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

46-
## Examples
50+
## Quick Links
4751

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

5056
## Contributing
5157

cookbook/demos/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

cookbook/examples/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

samples/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Samples
2+
3+
## Videos
4+
5+
| Title | Description | Link |
6+
|-------|-------------|------|
7+
| AI Powered YouTube Content Generator | Build an AI-powered tool to generate YouTube content | [Watch](https://youtu.be/6GcupNzH678) |
8+
9+
<!-- Add videos above -->
10+
11+
## Contributing
12+
13+
Have a sample to share? Open a PR to add it to this list.

0 commit comments

Comments
 (0)