Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Rearranging readme
  • Loading branch information
jdalrymple authored Jan 19, 2018
1 parent 0231702 commit fafdfac
Showing 1 changed file with 31 additions and 31 deletions.
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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>"
...
}
```

0 comments on commit fafdfac

Please sign in to comment.