archive-gh-me/gitbeaker
1
0
Fork 0
mirror of https://github.com/jdalrymple/gitbeaker.git synced 2026-01-18 15:55:30 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
Rearranging readme
This commit is contained in:
jdalrymple 2018-01-19 13:00:45 -05:00 committed by GitHub
parent 0231702164
commit fafdfacfb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -21,6 +21,7 @@ It wraps the HTTP v4 API library described [here](https://github.com/gitlabhq/gi
* [Groups](https://github.com/jdalrymple/node-gitlab-api/blob/master/docs/groups.md)
* [Contributors](#contributors)
* [Tests](#tests)
* [Development](#development)
* [License](#licence)
* [Changelog](#changelog)
@ -122,6 +123,36 @@ Although there are the official docs for the API, below are some additional docs
Nothing yet, but its on the TODO list :P
## Development
To get this running locally rather than from your `node_modules` folder:
```bash
$ git clone https://github.com/jdalrymple/node-gitlab-api.git
$ cd node-gitlab-api
$ npm install
$ npm build
```
And then inside whatever project you are using `node-gitlab-api` in you change your references to use that repo. In your package.json of that upstream project change:
```json
"dependencies": {
...
"node-gitlab-api": "2.1.0"
...
}
```
to this
```json
"dependencies": {
...
"node-gitlab-api": "<path-to-your-clone>"
...
}
```
## Contributors
This started off as a fork from [node-gitlab](https://github.com/node-gitlab/node-gitlab) but I ended up rewriting 90% of the code. Here are the original work's [contributors](https://github.com/node-gitlab/node-gitlab#contributors).
@ -328,34 +359,3 @@ inferred from the file path
------------------
- Initial release
- TODO: Tests, Examples
## Development
To get this running locally rather than from your `node_modules` folder:
```bash
$ git clone https://github.com/jdalrymple/node-gitlab-api.git
$ cd node-gitlab-api
$ npm install
$ npm build
```
And then inside whatever project you are using `node-gitlab-api` in you change your references to use that repo. In your package.json of that upstream project change:
```json
"dependencies": {
...
"node-gitlab-api": "2.1.0"
...
}
```
to this
```json
"dependencies": {
...
"node-gitlab-api": "<path-to-your-clone>"
...
}
```