diff --git a/README.md b/README.md index ea1d9b49..a0d373b0 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,32 @@ This is a [Singer](https://singer.io) tap that produces JSON-formatted data from the GitHub API following the [Singer -spec](https://github.com/singer-io/getting-started/blob/master/SPEC.md). +spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md). This tap: - Pulls raw data from the [GitHub REST API](https://developer.github.com/v3/) - Extracts the following resources from GitHub for a single repository: - - [Assignees](https://developer.github.com/v3/issues/assignees/#list-assignees) - - [Collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators) - - [Commits](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) - - [Issues](https://developer.github.com/v3/issues/#list-issues-for-a-repository) - - [Pull Requests](https://developer.github.com/v3/pulls/#list-pull-requests) - - [Comments](https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository) - - [Reviews](https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request) - - [Review Comments](https://developer.github.com/v3/pulls/comments/) - - [Stargazers](https://developer.github.com/v3/activity/starring/#list-stargazers) + - [Assignees](https://docs.github.com/en/rest/reference/issues#list-assigneess) + - [Collaborators](https://docs.github.com/en/rest/reference/repos#list-repository-collaborators) + - [Commits](https://docs.github.com/en/rest/reference/repos#list-commits) + - [Commit Comments](https://docs.github.com/en/rest/reference/repos#list-commit-comments-for-a-repository) + - [Events](https://docs.github.com/en/rest/reference/issues#events) + - [Issues](https://docs.github.com/en/rest/reference/issues#list-repository-issues) + - [Issue Events](https://docs.github.com/en/rest/reference/issues#list-issue-events-for-a-repository) + - [Issue Milestones](https://docs.github.com/en/rest/reference/issues#list-milestones) + - [Projects](https://docs.github.com/en/rest/reference/projects#list-repository-projects) + - [Project Cards](https://docs.github.com/en/rest/reference/projects#list-project-cards) + - [Project Columns](https://docs.github.com/en/rest/reference/projects#list-project-columns) + - [Pull Requests](https://docs.github.com/en/rest/reference/pulls#list-pull-requests) + - [PR Commits](https://docs.github.com/en/rest/reference/pulls#list-commits-on-a-pull-request) + - [Releases](https://docs.github.com/en/rest/reference/repos#list-releases) + - [Comments](https://docs.github.com/en/rest/reference/issues#list-issue-comments-for-a-repository) + - [Reviews](https://docs.github.com/en/rest/reference/pulls#list-reviews-for-a-pull-request) + - [Review Comments](https://docs.github.com/en/rest/reference/pulls#list-review-comments-in-a-repository) + - [Stargazers](https://docs.github.com/en/rest/reference/activity#list-stargazers) + - [Teams](https://docs.github.com/en/rest/reference/teams#list-teams) + - [Team Members](https://docs.github.com/en/rest/reference/teams#list-team-members) + - [Team Memberships](https://docs.github.com/en/rest/reference/teams#get-team-membership-for-a-user) - Outputs the schema for each resource - Incrementally pulls data based on the input state