Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
leewillis77 committed Feb 10, 2013
1 parent a7e03d2 commit 7036c83
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 4 deletions.
18 changes: 15 additions & 3 deletions README.md
Expand Up @@ -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:

Expand Down
9 changes: 8 additions & 1 deletion github-embed.php
Expand Up @@ -187,9 +187,13 @@ public function handle_oembed() {



/**
* 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 );

Expand Down Expand Up @@ -232,6 +236,9 @@ private function oembed_github_repo_contributors ( $owner, $repository ) {
die();

}



/**
* Retrieve the summary information for a repo's milestone, and
* output it as an oembed response
Expand Down
3 changes: 3 additions & 0 deletions readme.txt
Expand Up @@ -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:

Expand All @@ -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 ==

Expand Down
Binary file added screenshot-4.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7036c83

Please sign in to comment.