Added an example on how to checkout a remote branch.

jkukul · jkukul · commit 19c2e049c25f · 2018-05-14T00:22:31.000+02:00
diff --git a/examples/checkout-remote-branch.js b/examples/checkout-remote-branch.js
@@ -0,0 +1,26 @@
+var nodegit = require("../");
+var path = require("path");
+
+var remoteBranchName = "REMOTE-BRANCH-NAME";
+
+nodegit.Repository.open(path.resolve(__dirname, "../.git"))
+  .then(function(repo) {
+
+    return repo.getHeadCommit()
+      .then(function (targetCommit) {
+        return repo.createBranch(remoteBranchName, targetCommit, false);
+      })
+      .then(function (reference) {
+        return repo.checkoutBranch(reference, {});
+      })
+      .then(function () {
+        return repo.getReferenceCommit(
+          "refs/remotes/origin/" + remoteBranchName);
+      })
+      .then(function (commit) {
+        nodegit.Reset.reset(repo, commit, 3, {});
+      });
+
+  }).done(function() {
+  console.log("All done!");
+});
