mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
95 lines
3.0 KiB
Markdown
95 lines
3.0 KiB
Markdown
# Octokit - GitHub API Client Library for .NET
|
|
|
|
|
|
[](https://codecov.io/gh/octokit/octokit.net)
|
|
[](https://gitter.im/octokit/octokit.net?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://www.nuget.org/packages/Octokit)
|
|
[](https://www.nuget.org/packages/Octokit.Reactive)
|
|
|
|
|
|
|
|
Octokit is a client library targeting .NET Framework 4.6 or greater and .NET Standard 2.0
|
|
and above that provides an easy way to interact with the
|
|
[GitHub API](http://developer.github.com/v3/).
|
|
|
|
## Usage examples
|
|
|
|
Get public info on a specific user.
|
|
|
|
```c#
|
|
var github = new GitHubClient(new ProductHeaderValue("MyAmazingApp"));
|
|
var user = await github.User.Get("half-ogre");
|
|
Console.WriteLine(user.Followers + " folks love the half ogre!");
|
|
```
|
|
|
|
## Supported Platforms
|
|
|
|
* .NET 4.6.1 (Desktop / Server) or greater
|
|
* [.NET Standard 2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) or greater
|
|
|
|
## Getting Started
|
|
|
|
Octokit is a GitHub API client library for .NET and is [available on NuGet](https://www.nuget.org/packages/Octokit/):
|
|
|
|
```
|
|
dotnet add package Octokit
|
|
```
|
|
|
|
There is also an IObservable based GitHub API client library for .NET using Reactive Extensions:
|
|
|
|
```
|
|
dotnet add package Octokit.Reactive
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Documentation is available at http://octokitnet.readthedocs.io/en/latest/.
|
|
|
|
## Build
|
|
|
|
Octokit is a single assembly designed to be easy to deploy anywhere.
|
|
|
|
To clone and build it locally click the "Clone in Desktop" button above or run the
|
|
following git commands.
|
|
|
|
```
|
|
git clone git@github.com:octokit/Octokit.net.git Octokit
|
|
cd Octokit
|
|
```
|
|
|
|
To build the libraries, run the following command:
|
|
|
|
Windows: `.\build.ps1`
|
|
|
|
Linux/OSX: `./build.sh`
|
|
|
|
## Contribute
|
|
|
|
Visit the [Contributor Guidelines](https://github.com/octokit/octokit.net/blob/main/CONTRIBUTING.md)
|
|
for more details. All contributors are expected to follow our
|
|
[Code of Conduct](https://github.com/octokit/octokit.net/blob/main/CODE_OF_CONDUCT.md).
|
|
|
|
## Problems?
|
|
|
|
If you find an issue with our library, please visit the [issue tracker](https://github.com/octokit/octokit.net/issues)
|
|
and report the issue.
|
|
|
|
Please be kind and search to see if the issue is already logged before creating
|
|
a new one. If you're pressed for time, log it anyways.
|
|
|
|
When creating an issue, clearly explain
|
|
|
|
* What you were trying to do.
|
|
* What you expected to happen.
|
|
* What actually happened.
|
|
* Steps to reproduce the problem.
|
|
|
|
Also include any other information you think is relevant to reproduce the
|
|
problem.
|
|
|
|
## Copyright and License
|
|
|
|
Copyright 2023 GitHub, Inc.
|
|
|
|
Licensed under the [MIT License](https://github.com/octokit/octokit.net/blob/main/LICENSE.txt)
|