My Timeline - Github Plugin
Github Integration with My Timeline
Requirements:
- My Timeline
- Octokit gem
Usage:
- Add this gem to your Gemfile:
gem 'my_timeline-github'
andbundle install
- Register your application with Github to get
client_id
andclient_secret
keys. - Edit
config/initializers/my_timeline.rb
to include your Github OAUTH keys:
MyTimeline.setup do |config|
...
end
...
MyTimeline::Github.setup do |config|
config.client_id = "YOURKEY"
config.client_secret = "YOURKEY"
end
Current State
Github provides a wide variety of user activities. This plugin will eventually include them all, but they'll be coming one at a time...
- [ ] CommitCommentEvent
- [ ] CreateEvent
- [ ] DeleteEvent
- [ ] DownloadEvent
- [ ] FollowEvent
- [x] ForkEvent
- [ ] ForkApplyEvent
- [ ] GistEvent
- [ ] GollumEvent
- [ ] IssueCommentEvent
- [ ] IssuesEvent
- [ ] MemberEvent
- [ ] PublicEvent
- [ ] PullRequestEvent
- [ ] PullRequestReviewCommentEvent
- [ ] PushEvent
- [ ] ReleaseEvent
- [ ] StatusEvent
- [ ] TeamAddEvent
- [ ] WatchEvent
Credits
Original author: Justin Aiken
Links
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Commit, do not mess with rakefile, version, or history.
- If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
- Send me a pull request. Bonus points for topic branches.
Copyright
Copyright (c) 2013 Justin Aiken Inc. MIT license (see LICENSE for details).