diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..b5f80a49 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,19 @@ +# Octokit.net + +This is a place for putting together some introductory documentation about how to use Octokit.net. + +Possible topics to cover: + + - Authentication + - Working with Repositories + - Working with User data + - Working with Git data + - Searching Repositories + - ... + +If you're not sure where to start, there's a suite of +[integration tests](https://github.com/octokit/octokit.net/tree/master/Octokit.Tests.Integration/Clients) +which can help you to get familiar with how things currently work. + +Love and Octocats, +The Octokit.net Team