diff --git a/README.md b/README.md index 2f94d21..c5d8804 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,21 @@ Plugin that allows you to embed details from github just by pasting in the URL as you would any other embed source. Currently supports: -* Repositories -* User profiles -* Milestone summaries +### Repositories +__https://github.com/leewillis77/wp-github-oembed__ +![Sample output for repository](https://raw.github.com/leewillis77/wp-github-oembed/master/screenshot-1.png) + +### User profiles +__https://github.com/leewillis77/__ +![Sample output for a user](https://raw.github.com/leewillis77/wp-github-oembed/master/screenshot-2.png) + +### Milestone summaries +__https://github.com/leewillis77/wp-github-oembed/issues?milestone=1&state=open__ +![Sample output for a milestone](https://raw.github.com/leewillis77/wp-github-oembed/master/screenshot-3.png) + +### Repository contributors +__https://github.com/leewillis77/wp-github-oembed/graphs/contributors__ +![Sample output for a list of contributors](https://raw.github.com/leewillis77/wp-github-oembed/master/screenshot-4.png) Coming soon: diff --git a/github-embed.php b/github-embed.php index e0c6ef4..a75784b 100644 --- a/github-embed.php +++ b/github-embed.php @@ -187,9 +187,13 @@ class github_embed { + /** + * Retrieve a list of contributors for a project + * @param string $owner The owner of the repository + * @param string $repository The repository name + */ private function oembed_github_repo_contributors ( $owner, $repository ) { - $repo = $this->api->get_repo ( $owner, $repository ); $contributors = $this->api->get_repo_contributors ( $owner, $repository ); @@ -232,6 +236,9 @@ class github_embed { die(); } + + + /** * Retrieve the summary information for a repo's milestone, and * output it as an oembed response diff --git a/readme.txt b/readme.txt index 3817f8e..4fee22c 100644 --- a/readme.txt +++ b/readme.txt @@ -13,6 +13,7 @@ Plugin that allows you to embed details from github just by pasting in the URL a * Repositories * User profiles * Project milestone summaries +* Project contributors Coming soon: @@ -37,6 +38,8 @@ Not yet, we're hoping to add templating - [all contributions welcome](https://gi 1. GitHub Repository 2. GitHub user profile +3. Project milestone summaries +4. Project contributors == Changelog == diff --git a/screenshot-4.png b/screenshot-4.png new file mode 100644 index 0000000..fd48dea Binary files /dev/null and b/screenshot-4.png differ