node-gitlab-api - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

package.json

 {
   "name": "node-gitlab-api",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Full NodeJS implementation of the GitLab API. Supports Promises, Async/Await.",
@@ -25,3 +25,3 @@ "main": "src/index.js",
     "eslint": "^4.2.0",
-    "eslint-config-airbnb": "^15.0.2",
+    "eslint-config-airbnb": "^16.1.0",
     "eslint-plugin-import": "^2.2.0",
@@ -28,0 +28,0 @@ "eslint-plugin-jsx-a11y": "^6.0.2",

README.md

@@ -1,3 +0,5 @@
-[![dependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api)[![devDependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/dev-status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api?type=dev)[![Code Climate](https://codeclimate.com/github/jdalrymple/node-gitlab-api/badges/gpa.svg)](https://codeclimate.com/github/jdalrymple/node-gitlab-api)
+[![dependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api)[![devDependencies Status](https://david-dm.org/jdalrymple/node-gitlab-api/dev-status.svg)](https://david-dm.org/jdalrymple/node-gitlab-api?type=dev)[![Code Climate](https://codeclimate.com/github/jdalrymple/node-gitlab-api/badges/gpa.svg)](https://codeclimate.com/github/jdalrymple/node-gitlab-api)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+
+
 [![NPM](https://nodei.co/npm/node-gitlab-api.png?downloads=true&stars=true)](https://nodei.co/npm/node-gitlab-api/)
@@ -31,10 +33,13 @@
 
+Instantiate the library using a basic token created in your [Gitlab Profile](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
 ```javascript
-// Connection with basic token
 const GitlabAPI = require('node-gitlab-api')({
   url:   'http://example.com', // Defaults to http://gitlab.com
-  token: 'abcdefghij123456'
+  token: 'abcdefghij123456'	//Can be created in your profile. 
 })
-  
-// Connection with oauth token
+```
+
+Or, use a oauth token instead!
+
+```javascript
 const GitlabAPI = require('node-gitlab-api')({
@@ -44,12 +49,20 @@ url:   'http://example.com', // Defaults to http://gitlab.com
 })
+```
 
+Once you have your library instatiated, you can utilize many of the api's functionality:
+
+Using the await/async method
+
+```javascript
 // Listing users
-let users = await gitlab.users.all();
+let users = await GitlabAPI.users.all();
+```
 
-console.log(users);
-
+Or using Promise-Then notation
+```javascript
 // Listing projects
-let projects = await gitlab.projects.all();
-
-console.log(projects);
+gitlab.projects.all()
+.then((projects) => {
+	console.log(projects)
+})
 ```
@@ -100,11 +113,17 @@
 - [Dylan DesRosier](https://github.com/ddesrosier)
+- [Shady Grove](https://github.com/shadygrove)
+- [Christoph Lehmann](https://github.com/christophlehmann)
+- [Frank V](https://github.com/FrankV01)
 
-
 ## License
 
-MIT
+[MIT](https://github.com/jdalrymple/node-gitlab-api/blob/master/LICENSE.md)
 
 ## Changelog
+[1.1.3](https://github.com/jdalrymple/node-gitlab-api/6f28ce1726ce371d4b0272d5f8305080d51e3e25) (2017-11-17)
+------------------
+- Fixing typos in the project sharing (group_access) thanks to [Christoph Lehmann](https://github.com/christophlehmann)
+- Updated the ReadMe to be more clear based on suggestions from [Frank V](https://github.com/FrankV01)
 
-[1.1.2](https://github.com/jdalrymple/node-gitlab-api/36570c32be7cd564bda9c7c7dc07059987969bd4) (2017-09-24)
+[1.1.2](https://github.com/jdalrymple/node-gitlab-api/36570c32be7cd564bda9c7c7dc07059987969bd4) (2017-10-29)
 ------------------
@@ -111,0 +130,0 @@ - Updated the protected branch functionality by adding an options parameter originally proposed by [shadygrove](https://github.com/shadygrove)

src/Models/Projects.js

@@ -82,3 +82,3 @@ const Fs = require('fs');
     options.group_id = groupId;
-    options.groupAccess = groupAccess;
+    options.group_access = groupAccess;
 
@@ -85,0 +85,0 @@ return this.post(`projects/${pId}/share`, options);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46885

increased by2.22%

Number of lines in readme file

210

increased by9.95%

No dependency changes