Add guide for initializing a repo

John Haley · John Haley · commit b09070893850 · 2015-03-12T10:48:29.000-07:00
diff --git a/guides/repositories/initializing/README.md b/guides/repositories/initializing/README.md
@@ -5,6 +5,59 @@ title: Initializing
 description: How to initialize a repository
 ---
 
+**In order to run examples, you will need to [Install NodeGit](../../install/basics)
+first.**
+
 [Return to repository guides](../)
 
 * * *
+
+Initializing a Repository
+-------------------------
+
+This guide explains how to create a new repository.
+
+[View example source](index.js)
+
+### Requiring NodeGit
+
+In the guides directory, we like to keep our NodeGit relative to the project
+root.
+
+``` javascript
+var NodeGit = require("../../../");
+```
+
+However, in your project you will most likely be using the following command:
+
+``` javascript
+var NodeGit = require("nodegit");
+```
+
+### Arguments to initialize a repo
+
+There are 2 arguments to the `init` method, a path to initialize the repo in
+and whether or not to make a `.git` subfolder in that directory or use the
+passed in directory as the `.git` folder itself.
+
+
+``` javascript
+var pathToRepo = require("path").resolve("../my-git-projects/my-project");
+var isBare = 0; // lets create a .git subfolder
+```
+
+
+### Initialize the Repo
+
+Now that we have our arguments we can call the `init` method on the
+`NodeGit.Repository` module to create the repo.
+
+``` javascript
+NodeGit.Repository.init(pathToRepo, isBare).then(function (repo) {
+  // In this function we have a repo object that we can perform git operations
+  // on.
+
+  // Note that with a new repository many functions will fail until there is
+  // an initial commit.
+});
+```
diff --git a/guides/repositories/initializing/index.js b/guides/repositories/initializing/index.js
@@ -0,0 +1,29 @@
+// Require in NodeGit, since we want to use the local copy, we're using a
+// relative path.  In your project, you will use:
+//
+// var NodeGit = require("nodegit");
+var NodeGit = require("../../../");
+
+// Using the `init` method from the `NodeGit.Repository` module, we can create
+// a blank repository using NodeGit
+var pathToRepo = require("path").resolve("../my-git-projects/my-project");
+
+// Setting this to 0 will have the effect creating a `.git` folder inside of
+// passed path. If this is 1 then we will use the passed path AS our `.git`
+// folder.
+var isBare = 0;
+
+// In NodeGit we use Promises to make callbacks easier to deal with.
+//
+// For more information visit https://www.promisejs.org/
+NodeGit.Repository.init(pathToRepo, isBare).then(function (repo) {
+  // In this function we have a repo object that we can perform git operations
+  // on.
+
+  // Note that with a new repository many functions will fail until there is
+  // an initial commit.
+})
+.catch(function (reasonForFailure) {
+  // If the repo cannot be created for any reason we can handle that case here.
+  // NodeGit won't init a repo over a pre-existing repo.
+});
