Skip to content

Commit eb879ce

Browse files
committed
Add explanation for the breaking changes.
1 parent a36fa9d commit eb879ce

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

github_api.gemspec

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,22 @@ Gem::Specification.new do |gem|
3030
gem.add_development_dependency 'guard-cucumber', '0.7.4'
3131
gem.add_development_dependency 'rake'
3232
gem.add_development_dependency 'bundler'
33+
34+
gem.post_install_message = %{
35+
--------------------------------------------------------------------------------
36+
Thank you for installing github_api-#{Github::VERSION::STRING.dup}.
37+
38+
*NOTE*: Version 0.5.0 introduces breaking changes to the way github api is queried.
39+
The interface has been rewritten to be more consistent with REST verbs that
40+
interact with GitHub hypermedia resources. Thus, to list resources 'list' or 'all'
41+
verb is used, to retrieve individual resource 'get' or 'find' verbs are used.
42+
Further CRUDE operations on all resources use preditable verbs as well.
43+
44+
Again sorry for inconvenience but I trust that this will help in easier access to
45+
the GitHub API.
46+
47+
For more information: http://rubydoc.info/github/peter-murach/github/master/frames
48+
49+
--------------------------------------------------------------------------------
50+
}
3351
end

0 commit comments

Comments
 (0)