UNPKG

git/README.md

Version:

1.77 kBMarkdownView Raw

1[![build status](https://secure.travis-ci.org/christkv/node-git.png)](http://travis-ci.org/christkv/node-git)
2
3# Introduction
4
5This is a library for Git written in Node.js. It's as close a port of grit http://github.com/mojombo/grit.
6
7The idea is to allow for manipulation of git repositories by the node.js application. Not everything is
8implemented directly in node-git. Some of the stuff is using the native git command line instead of
9direct javascript code. Also it's fairly synchronous right now but that will hopefully change a little
10by little over time as it gets more stable and I start using it in real life scenarios.
11
12## Github information
13
14The source code is available at http://github.com/christkv/node-git.
15You can either clone the repository or download a tarball of the latest release.
16
17Once you have the source you can test the driver by running
18
19	$ make test
20
21On windows:
22
23	PS > node.exe .\node_modules\nodeunit\bin\nodeunit .\test
24	
25## Examples
26
27For simple examples of usage look at the tests included in the repository.
28
29## Notes
30
31The current version is basic git support, don't expect everything to work as you expect it
32off the bat.
33
34## License
35
36	Copyright 2009 - 2010 Christian Amor Kvalheim.
37
38	  Licensed under the Apache License, Version 2.0 (the "License");
39	  you may not use this file except in compliance with the License.
40	  You may obtain a copy of the License at
41
42	      http://www.apache.org/licenses/LICENSE-2.0
43
44	  Unless required by applicable law or agreed to in writing, software
45	  distributed under the License is distributed on an "AS IS" BASIS,
46	  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
47	  See the License for the specific language governing permissions and
48	  limitations under the License.

1	`[![build status](https://secure.travis-ci.org/christkv/node-git.png)](http://travis-ci.org/christkv/node-git)`
2
3	`# Introduction`
4
5	`This is a library for Git written in Node.js. It's as close a port of grit http://github.com/mojombo/grit.`
6
7	`The idea is to allow for manipulation of git repositories by the node.js application. Not everything is`
8	`implemented directly in node-git. Some of the stuff is using the native git command line instead of`
9	`direct javascript code. Also it's fairly synchronous right now but that will hopefully change a little`
10	`by little over time as it gets more stable and I start using it in real life scenarios.`
11
12	`## Github information`
13
14	`The source code is available at http://github.com/christkv/node-git.`
15	`You can either clone the repository or download a tarball of the latest release.`
16
17	`Once you have the source you can test the driver by running`
18
19	`$ make test`
20
21	`On windows:`
22
23	`PS > node.exe .\node_modules\nodeunit\bin\nodeunit .\test`
24
25	`## Examples`
26
27	`For simple examples of usage look at the tests included in the repository.`
28
29	`## Notes`
30
31	`The current version is basic git support, don't expect everything to work as you expect it`
32	`off the bat.`
33
34	`## License`
35
36	`Copyright 2009 - 2010 Christian Amor Kvalheim.`
37
38	`Licensed under the Apache License, Version 2.0 (the "License");`
39	`you may not use this file except in compliance with the License.`
40	`You may obtain a copy of the License at`
41
42	`http://www.apache.org/licenses/LICENSE-2.0`
43
44	`Unless required by applicable law or agreed to in writing, software`
45	`distributed under the License is distributed on an "AS IS" BASIS,`
46	`WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.`
47	`See the License for the specific language governing permissions and`
48	`limitations under the License.`