module Octokit::Client::Contents

def readme(repo, options = {})

Other tags:
    Example: Get the readme file for a particular branch of the repo -
    Example: Get the readme file for a repo -

Other tags:
    See: https://developer.github.com/v3/repos/contents/#get-the-readme -

Returns:
  • (Sawyer::Resource) - The detail of the readme

Options Hash: (**options)
  • :ref (String) -- name of the Commit/Branch/Tag. Defaults to “master”.

Parameters:
  • repo (Integer, String, Repository, Hash) -- A GitHub repository 
def readme(repo, options = {})
  get "#{Repository.path repo}/readme", options
end