MCPcopy Index your code
hub / github.com/github-tools/github / getReadme

Method getReadme

lib/Repository.js:522–526  ·  view source on GitHub ↗

* Get the README of a repository * @see https://developer.github.com/v3/repos/contents/#get-the-readme * @param {string} ref - the ref to check * @param {boolean} raw - `true` if the results should be returned raw instead of GitHub's normalized format * @param {Requestable.callback}

(ref, raw, cb)

Source from the content-addressed store, hash-verified

520 * @return {Promise} - the promise for the http request
521 */
522 getReadme(ref, raw, cb) {
523 return this._request('GET', `/repos/${this.__fullname}/readme`, {
524 ref,
525 }, cb, raw);
526 }
527
528 /**
529 * Fork a repository

Callers 1

repository.spec.jsFile · 0.80

Calls 1

_requestMethod · 0.80

Tested by

no test coverage detected