|
1 | | -Node.js libgit2 bindings [](https://travis-ci.org/tbranyen/nodegit) |
2 | | -======================= |
| 1 | +nodegit |
| 2 | +======= |
3 | 3 |
|
4 | | -Created by Tim Branyen [@tbranyen](http://twitter.com/tbranyen) |
| 4 | +> Node.js libgit2 bindings |
5 | 5 |
|
6 | | -Currently under active development (and seeking contributions), `nodegit` provides asynchronous native bindings to the [`libgit2`](http://libgit2.github.com/libgit2/) C API. |
| 6 | +**v0.0.72** [](https://travis-ci.org/tbranyen/nodegit) |
7 | 8 |
|
| 9 | +Maintained by Tim Branyen [@tbranyen](http://twitter.com/tbranyen) and Michael |
| 10 | +Robinson [@codeofinterest](http://twitter.com/codeofinterest), with help from |
| 11 | +[awesome |
| 12 | +contributors](https://github.com/tbranyen/nodegit/contributors)! |
8 | 13 |
|
9 | 14 | Contributing |
10 | 15 | ------------ |
11 | 16 |
|
12 | | -Nodegit aims to eventually provide native asynchronous bindings for as much of libgit2 as possible, but we can't do it alone! |
| 17 | +Nodegit aims to eventually provide native asynchronous bindings for as much of |
| 18 | +libgit2 as possible, but we can't do it alone! |
13 | 19 |
|
14 | | -We welcome pull requests, but please pay attention to the following: whether your lovely code fixes a bug or adds a new feature, please include unit tests that either prove the bug is fixed, or that your new feature works as expected. See [running tests](#running-tests) |
| 20 | +We welcome pull requests, but please pay attention to the following: whether |
| 21 | +your lovely code fixes a bug or adds a new feature, please include unit tests |
| 22 | +that either prove the bug is fixed, or that your new feature works as expected. |
| 23 | +See [running tests](#running-tests) |
15 | 24 |
|
16 | 25 | Unit tests are what makes the Node event loop go around. |
17 | 26 |
|
18 | 27 | Building and installing |
19 | 28 | ----------------------- |
20 | 29 |
|
21 | 30 | ### Dependencies ### |
22 | | -To run `nodegit` you need `Node.js` and to run unit tests you will need to have `git` installed and accessible from your `PATH` to fetch any `vendor/` addons. |
| 31 | +To run `nodegit` you need `Node.js` and to run unit tests you will need to have |
| 32 | +`git` installed and accessible from your `PATH` to fetch any `vendor/` addons. |
23 | 33 |
|
24 | 34 | ### Easy install (Recommended) ### |
25 | 35 | This will install and configure everything you need to use `nodegit`. |
@@ -255,6 +265,10 @@ __Can keep track of current method coverage at: [http://bit.ly/tb_methods](http: |
255 | 265 | Getting involved |
256 | 266 | ---------------- |
257 | 267 |
|
258 | | -If you find this project of interest, please document all issues and fork if you feel you can provide a patch. Testing is of huge importance; by simply running the unit tests on your system and reporting issues you can contribute! |
| 268 | +If you find this project of interest, please document all issues and fork if |
| 269 | +you feel you can provide a patch. Testing is of huge importance; by simply |
| 270 | +running the unit tests on your system and reporting issues you can contribute! |
259 | 271 |
|
260 | | -__Before submitting a pull request, please ensure both that you've added unit tests to cover your shiny new code, and that all unit tests and lint checks pass.__ |
| 272 | +__Before submitting a pull request, please ensure both that you've added unit |
| 273 | +tests to cover your shiny new code, and that all unit tests and lint checks |
| 274 | +pass.__ |
0 commit comments