Skip to content

Commit

Permalink
Updating readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
jdalrymple committed Jan 23, 2018
1 parent e864064 commit 6185424
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 33 deletions.
66 changes: 35 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ 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 @@ -123,36 +122,6 @@ 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 All @@ -176,6 +145,10 @@ This started off as a fork from [node-gitlab](https://github.com/node-gitlab/nod

## Changelog

[2.2.1](https://github.com/jdalrymple/node-gitlab-api/e864064c98feda59d594d77b67f7d0657db78700) (2018-1-23)
------------------
Added support for the Version API through version.show()

[2.2.0](https://github.com/jdalrymple/node-gitlab-api/96e414a75ad97e88ecaaff15a6c1409a9e27b963) (2018-1-18)
------------------
- Fixed the missing options parameter for the ProjectRepositoryCommitComment's model thanks to [Martin Benninger](https://github.com/MartinBenninger) in PR [#21](https://github.com/jdalrymple/node-gitlab-api/pull/21)
Expand Down Expand Up @@ -359,3 +332,34 @@ 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>"
...
}
```
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-gitlab-api",
"version": "2.2.0",
"version": "2.2.1",
"description": "Full NodeJS implementation of the GitLab API. Supports Promises, Async/Await.",
"main": "dist/latest/index.js",
"engines": {
Expand All @@ -18,7 +18,6 @@
},
"keywords": [
"gitlab",
"git",
"api",
"es6",
"es5",
Expand Down

0 comments on commit 6185424

Please sign in to comment.