22layout : default
33menu_item : getting_started
44sections :
5- " About " : " #about"
6- " Quick install " : " #quick-install"
7- " Include library " : " #include-library"
8- " Cloning a Repository " : " #cloning-a-repository"
9- " Opening a Repository " : " #opening-a-repository"
10- " Brought to you by... " : " #brought-to-you-by"
11- " Used by... " : " #used-by"
5+ " Using NodeGit " : " #clone-a-repository"
126
137---
148
15- ## <a name =" about " ></a >About NodeGit
16-
17- If you are working with low-level Git operations and want excellent
18- performance, NodeGit is for you. This project provides well tested, cross
19- platform bindings to the [ libgit2] ( https://libgit2.github.com ) library for
20- Node.
21-
22- ### Current stable version: 0.3.0
23-
24- <table >
25- <thead >
26- <tr>
27- <th>Linux</th>
28- <th>OS X</th>
29- <th>Windows</th>
30- <th>Dependencies</th>
31- </tr>
32- </thead >
33- <tbody >
34- <tr>
35- <td colspan="2" align="center">
36- <a href="https://travis-ci.org/nodegit/nodegit"><img src="https://travis-ci.org/nodegit/nodegit.svg"></a>
37- </td>
38- <td align="center">
39- <a href="https://ci.appveyor.com/project/timbranyen/nodegit"><img src="https://ci.appveyor.com/api/projects/status/e5a5q75l9yfhnfv2?svg=true"></a>
40- </td>
41- <td align="center">
42- <a href="https://david-dm.org/nodegit/nodegit"><img src="https://david-dm.org/nodegit/nodegit.svg"></a>
43- </td>
44- </tr>
45- </tbody >
46- </table >
47-
48- ## <a name =" quick-install " ></a >Quick install
49-
509NodeGit can be quickly and painlessly installed via NPM:
5110
5211``` bash
@@ -57,15 +16,17 @@ For more comprehensive installation techniques, check out the [Install Guides](
5716/guides/install
5817)
5918
60- ## <a name =" include-library " ></a >Include library
19+ * * *
20+
21+ ## <a name =" using-nodegit " ></a >Using NodeGit
6122
6223You simply need to require NodeGit in your project to start using it.
6324
6425``` javascript
6526var Git = require (" nodegit" );
6627```
6728
68- ## <a name =" cloning -a-repository" ></a >Cloning a Repository
29+ ### <a name =" clone -a-repository" ></a >Clone a Repository
6930
7031Let's learn how to clone a repository. Create a file named ` clone.js ` ,
7132and add the following code:
@@ -76,7 +37,7 @@ Git.Clone("https://github.com/nodegit/nodegit", "tmp").then(function(repository)
7637});
7738```
7839
79- ## <a name =" opening -a-repository" ></a >Opening a Repository
40+ ## <a name =" open -a-repository" ></a >Open a Repository
8041
8142Let's learn how to open a repository. Create a file named ` open.js ` ,
8243and add the following code:
@@ -87,6 +48,8 @@ Git.Repository.open("tmp").then(function(repository) {
8748});
8849```
8950
51+ * * *
52+
9053## <a name =" brought-to-you-by " ></a >Brought to you by...
9154
9255A lot of talented developers over the world. We are proud to be sponsored by
0 commit comments