diff --git a/README.md b/README.md index b093bd70..179074a3 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,11 @@ [![Join the chat at https://gitter.im/PyGithub/PyGithub](https://badges.gitter.im/PyGithub/PyGithub.svg)](https://gitter.im/PyGithub/PyGithub?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Open Source Helpers](https://www.codetriage.com/pygithub/pygithub/badges/users.svg)](https://www.codetriage.com/pygithub/pygithub) -PyGitHub is a Python (2 and 3) library to access the [GitHub API v3]. +PyGitHub is a Python (2 and 3) library to access the [GitHub API v3] and [Github Enterprise API v3]. This library enables you to manage [GitHub] resources such as repositories, user profiles, and organizations in your Python applications. [GitHub API v3]: https://developer.github.com/v3 +[Github Enterprise API v3]: https://developer.github.com/enterprise/2.13/v3/ [GitHub]: https://github.com ## Install @@ -32,6 +33,9 @@ g = Github("user", "password") # or using an access token g = Github("access_token") +# Github Enterprise with custom hostname +g = Github(base_url="https://{hostname}/api/v3", login_or_token="access_token") + # Then play with your Github objects: for repo in g.get_user().get_repos(): print(repo.name)