readme.md

#FSharp.GitHubApi#

An F# implementation of a GitHub Api wrapper.

##Progress##

The Api current supports the following:

• Authentication (Basic)
• Rate Limit
• Get a single user
• Get the authenticated user
• Update the authenticated user
• Get all users
• List the authenticated user repositories
• List a specified user's repositories
• List an organization's repositories
• Create a new user repository
• Delete an existing repository
• List branches on a specified repository
• Get a specified repository
• Edit a specified repository
• List Contributors to a specified repository

##Notes##

Originally intended to just be part of OctocatTools - I've decided to move it out to be a separate repository and just use it as a submodule... and perhaps one day as a NuGet package or whatever.

##Development##

1. Run the ResolveDependencies.bat before development.
2. Edit the TestSettings.fs to include some valid GitHub credentials NOTE: Do not ever commit this file and push back to GitHub
3. Run the build.bat file to build/test the code base.