Skip to content
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

Jump to bottom

maint: Update README.md #18

Merged
merged 2 commits into from
Dec 13, 2023
Merged

maint: Update README.md #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfaa8d9
Update README.md
IEvangelist Dec 13, 2023
c266cf7
Update README.md
IEvangelist Dec 13, 2023
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
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
# dotnet-sdk
# Octokit: .NET SDK

[![Build and test .NET SDK](https://github.com/octokit/dotnet-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/octokit/dotnet-sdk/actions/workflows/build.yml) [![CodeQL](https://github.com/octokit/dotnet-sdk/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/octokit/dotnet-sdk/actions/workflows/github-code-scanning/codeql) [![Publish Release to NuGet](https://github.com/octokit/dotnet-sdk/actions/workflows/publish.yml/badge.svg)](https://github.com/octokit/dotnet-sdk/actions/workflows/publish.yml)

An "alpha" version of a generated .NET SDK in C# from [GitHub's OpenAPI spec](https://github.com/github/rest-api-description), built on [Kiota](https://github.com/microsoft/kiota).

## How do I use it?

```
```csharp
using GitHub.Client;
using GitHub.Authentication;

var token = Environment.GetEnvironmentVariable("GITHUB_TOKEN") ?? "";
var request = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen",token));
var gitHubClient = new Client(request);
var request = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", token));
var gitHubClient = new GitHubClient(request);

var pullRequests = await gitHubClient.Repos["octokit"]["octokit.net"].Pulls.GetAsync();
```

⚠️ **Note**: This SDK is not yet stable. Breaking changes may occur at any time.
> [!IMPORTANT]
> This SDK is not yet stable. Breaking changes may occur at any time.

## Why a generated SDK?

We want to...
1. provide 100% coverage of the API in our SDK
2. use this as a building block for future SDK tooling.
1. use this as a building block for future SDK tooling

## Why .NET?

Expand All @@ -42,7 +45,7 @@ Currently this project is fairly simple (we hope it can stay that way). All of

## More details on this SDK and repo

* [Code of conduct](Docs/CODE_OF_CONDUCT.md)
* [Contributing](Docs/CONTRIBUTING.md)
* [Releases](Docs/RELEASES.md)
* [Incidents and security](Docs/SECURITY.md)
- [Code of conduct](Docs/CODE_OF_CONDUCT.md)
- [Contributing](Docs/CONTRIBUTING.md)
- [Releases](Docs/RELEASES.md)
- [Incidents and security](Docs/SECURITY.md)
Loading