Skip to content

rstrobl/jquery-github-activity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jquery-github-activity

This plugin renders the activity of github users as a list to a given element. It makes use of the GitHub API v3.

Requirements

Usage

$("#gh-activity").githubActivityFor("username", {
    'limit': 10,                // limit number of event, default: 30 (max)
    'wrap': function(item) {	// post process item element, default: identity
        return item
    }
})

Events

see https://developer.github.com/v3/activity/events/types

Supported

  • CreateEvent
  • FollowEvent
  • PushEvent
  • WatchEvent
  • IssueCommentEvent
  • IssuesEvent
  • CommitCommentEvent
  • PullRequestEvent
  • DeleteEvent
  • ForkEvent
  • ReleaseEvent
  • GollumEvent
  • MemberEvent
  • PublicEvent

Not yet supported

  • PullRequestReviewCommentEvent
  • TeamAddEvent

Todo

  • additional options to the github-activity function
    • define custom renderers
    • implement remaining events
    • support for detailed events
  • finish unit tests implementation

About

renders a user's GitHub activity to a given markup element

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published