feature(repository): add getReadme

mversluys · clayreimann · commit 99b7e4b1c189 · 2016-06-02T10:27:58.000-05:00
Provides support for the preferred method of retrieving the README from a repository, as opposed to 
using `getContents`.
diff --git a/lib/Repository.js b/lib/Repository.js
@@ -404,6 +404,20 @@ class Repository extends Requestable {
       }, cb, raw);
    }
 
+   /**
+    * 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 {Function} cb - will receive the fetched data
+    * @return {Promise} - the promise for the http request
+    */
+   getReadme(ref, raw, cb) {
+      return this._request('GET', `/repos/${this.__fullname}/readme`, {
+         ref
+      }, cb, raw);
+   }
+
    /**
     * Fork a repository
     * @see https://developer.github.com/v3/repos/forks/#create-a-fork
diff --git a/test/repository.spec.js b/test/repository.spec.js
@@ -75,6 +75,14 @@ describe('Repository', function() {
          }));
       });
 
+      it('should show repo readme', function(done) {
+         remoteRepo.getReadme('master', 'raw', assertSuccessful(done, function(err, text) {
+            expect(text).to.contain('# Github.js');
+
+            done();
+         }));
+      });
+
       it('should get ref from repo', function(done) {
          remoteRepo.getRef('heads/master', assertSuccessful(done));
       });
