gh_readme: Get the README

Description Usage Arguments Value

View source: R/repositories.R

Description

urlhttps://developer.github.com/v3/repos/contents/#get-the-readme

Usage

1
gh_readme(ref, repo, api = getOption("github.api"), ...)

Arguments

ref

(string, optional) The name of the commit/branch/tag. Default: the repository<e2><80><99>s default branch (usually master).

repo

(string) The repository specified as "owner/repo".

api

(string, optional) The address to GitHub's API. Default: Uses the option github.api.

...

Parameters passed to gh_page.

Value

A string containing the contents of the README file.


ChadGoymer/github documentation built on June 1, 2017, 5:17 p.m.