diff --git a/README.md b/README.md index 3b005c65..74002962 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/cookbook/demos/README.md b/cookbook/demos/README.md deleted file mode 100644 index 4233de2b..00000000 --- a/cookbook/demos/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Demos & Examples - -## Sample Projects - -Explore complete sample projects and tutorials at **[copilot-sdk-samples.coreai.diy](https://copilot-sdk-samples.coreai.diy/)**. - -Quick start examples are also included with each SDK: - -| SDK | In-Repo Examples | -|-----|------------------| -| Node.js | [`nodejs/examples/`](../nodejs/examples/) | -| Python | [`python/`](../python/) | -| Go | [`go/`](../go/) | -| .NET | [`dotnet/`](../dotnet/) | - -## Videos - -| Title | Description | Link | -|-------|-------------|------| -| | | | - - - -## Contributing - -Have a demo or sample to share? Open a PR to add it to this list. diff --git a/cookbook/examples/README.md b/cookbook/examples/README.md deleted file mode 100644 index 4fc9d6ab..00000000 --- a/cookbook/examples/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Examples - -## Sample Projects - -Explore complete sample projects and tutorials at **[copilot-sdk-samples.coreai.diy](https://copilot-sdk-samples.coreai.diy/)**. - -Quick start examples are also included with each SDK: - -| SDK | In-Repo Examples | -|-----|------------------| -| Node.js | [`nodejs/examples/`](../nodejs/examples/) | -| Python | [`python/`](../python/) | -| Go | [`go/`](../go/) | -| .NET | [`dotnet/`](../dotnet/) | - -## Videos - -| Title | Description | Link | -|-------|-------------|------| -| | | | - - - -## Contributing - -Have a demo or sample to share? Open a PR to add it to this list. diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 00000000..283b0e2e --- /dev/null +++ b/samples/README.md @@ -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) | + + + +## Contributing + +Have a sample to share? Open a PR to add it to this list.