From fafdfacfb1418ec4845c9d7ac7e732f7502dfffc Mon Sep 17 00:00:00 2001 From: jdalrymple Date: Fri, 19 Jan 2018 13:00:45 -0500 Subject: [PATCH] Update README.md Rearranging readme --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index d1557700..cccd0f4f 100644 --- a/README.md +++ b/README.md @@ -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": "" + ... + } +``` ## 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": "" - ... - } -``` \ No newline at end of file