@axosoft/glo-sdk - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "@axosoft/glo-sdk",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "JavaScript SDK for GitKraken Glo APIs",
		@@ -11,3 +11,3 @@ "main": "dist/index.js",
		"test:watch": "jest --watch",
		"prepublish": "yarn build && yarn test"
		"prepublishOnly": "yarn build"
		},
		@@ -14,0 +14,0 @@ "author": "James Quigley",

README.md

		# GitKraken Glo JavaScript SDK
		[![Build Status](https://travis-ci.org/James-Quigley/glo-node-sdk.svg?branch=master)](https://travis-ci.org/James-Quigley/glo-node-sdk)

		![](https://img.shields.io/github/license/Axosoft/glo-sdk.svg?style=flat)
		[![Build Status](https://travis-ci.org/Axosoft/glo-sdk.svg?branch=master)](https://travis-ci.org/Axosoft/glo-sdk)
		![](https://img.shields.io/bundlephobia/min/@axosoft/glo-sdk.svg?label=size&style=flat)
		![](https://img.shields.io/npm/dt/@axosoft/glo-sdk.svg?style=flat)

		GitKraken Glo API [documentation](https://gloapi.gitkraken.com/v1/docs)

		## How to Use
		NOT YET ON NPM

		`npm install -S @axosoft/glo-sdk`
		`yarn add @axosoft/glo-sdk`
		### Install

		`const gloApi = require('glo-sdk');`
		`import gloApi from 'glo-sdk';`
		npm:
		```
		npm install -S @axosoft/glo-sdk
		```
		yarn
		```
		yarn add @axosoft/glo-sdk
		```

		```
		### Example Usage

		You must pass in an auth token. All method calls return a promise, so you should properly handle errors with a .catch or a try/catch block if using async/await.

		```javascript
		// Import options
		const gloApi = require('@axosoft/glo-sdk');
		import gloApi from '@axosoft/glo-sdk';


		// Usage
		gloApi(authToken).boards.getAll()
		.then(boards => console.log(boards))
		.catch(error => console.error(error));

		try {
		const boards = await gloApi(authToken).boards.getAll();
		} catch (error) {
		console.log(error);
		}
		```

New alerts