Method: Github::Repos::Contents#readme

Defined in:
lib/github_api/repos/contents.rb

#readme(*args) ⇒ Object

Get the README

This method returns the preferred README for a repository.

Examples

github = Github.new
github.repos.contents.readme 'user-name', 'repo-name'

content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'
content.readme



22
23
24
25
26
27
 
# File 'lib/github_api/repos/contents.rb', line 22

def readme(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/readme", params)
end