kitsu - npm Package Compare versions

Comparing version 3.1.3 to 3.1.4

CHANGELOG.md

@@ -1,12 +0,31 @@
-#### 3.1.2 (2017-11-26)
+#### 3.1.4 (2017-12-12)
 
 ##### Chores
 
+* update release scripts ([6f81ed9a](https://github.com/wopian/kitsu/commit/6f81ed9ac521f434fc3c169faf4c773ab3499f1c))
+* remove 3.1.2 commits from 3.1.3 changelog ([64acafd5](https://github.com/wopian/kitsu/commit/64acafd55bb623d1464afcd4ed8027ba66e7b46a))
+* fix changelog versioning ([53c10dab](https://github.com/wopian/kitsu/commit/53c10dab5f539adc8b1c81566da7831ff2eb6159))
 * update build scripts ([bc3b1807](https://github.com/wopian/kitsu/commit/bc3b1807238391afbe536a0f65271abf56da12c6))
 * use common error function ([c25e4dc2](https://github.com/wopian/kitsu/commit/c25e4dc2cf81c7f4058239039ecdd5bff8604270))
+* **deps:**
+  * renovate eslint packages (#68) ([151405ff](https://github.com/wopian/kitsu/commit/151405ff5df73b9c2b41b833699a8a61575357a5))
+  * renovate eslint packages (#67) ([b8c66c25](https://github.com/wopian/kitsu/commit/b8c66c256f96733636e6bb605956ee265d240b4f))
+  * update generate-changelog to ~1.6.0 (#65) ([563fc22b](https://github.com/wopian/kitsu/commit/563fc22bf2af8fc5b15b8d844d22fb15d5591700))
+  * update rollup to ~0.52.0 (#66) ([853fa39d](https://github.com/wopian/kitsu/commit/853fa39d6b2e8a017428324493a4f8b123d5cdfc))
 
 ##### Continuous Integration
 
+* **travis:**
+  * use existing oauth token ([1f7f8373](https://github.com/wopian/kitsu/commit/1f7f83733796774b4941600cd43b7f2138a5a7d7))
+  * add package files to github releases ([2c6e577e](https://github.com/wopian/kitsu/commit/2c6e577e9a7712dfc2305f319bc28ef436aac4a2))
 * test against LTS node versions ([184ee6f7](https://github.com/wopian/kitsu/commit/184ee6f7b4a0bcf909fea3ef9594155f89b0f605))
 
+##### Documentation Changes
+
+* add contributors badge ([7bb04ba8](https://github.com/wopian/kitsu/commit/7bb04ba8860f3741285a9dba1c04074c4fbf0439))
+* fix kitsu.io docs url ([39b337a1](https://github.com/wopian/kitsu/commit/39b337a1ea61de2ff7194dee17e280f163a93a69))
+* update donation link ([c43b10b3](https://github.com/wopian/kitsu/commit/c43b10b38cd053f8608f3ae1816044143e97d216))
+* use https for kitsu.io api docs link ([c0494cbc](https://github.com/wopian/kitsu/commit/c0494cbc1fa51fb465c2888e8ca9edb1170d8cf6))
+* update badges and add example response comparison ([70be0a71](https://github.com/wopian/kitsu/commit/70be0a71707b81cc2a19e324f7ff1485faedcbed))
+
 ##### Bug Fixes
@@ -16,13 +35,8 @@
 
-#### 3.1.2 (2017-11-24)
+#### 3.1.3 (2017-11-26)
 
-##### Chores
+##### Bug Fixes
 
-* update build scripts ([bc3b1807](https://github.com/wopian/kitsu/commit/bc3b1807238391afbe536a0f65271abf56da12c6))
-* use common error function ([c25e4dc2](https://github.com/wopian/kitsu/commit/c25e4dc2cf81c7f4058239039ecdd5bff8604270))
+* add parentheses to fix short-circuiting of URL version (#64) ([b74fd7e3](https://github.com/wopian/kitsu/commit/b74fd7e37c9913a20b6efbe6a96503b48473817c))
 
-##### Continuous Integration
-
-* test against LTS node versions ([184ee6f7](https://github.com/wopian/kitsu/commit/184ee6f7b4a0bcf909fea3ef9594155f89b0f605))
-
 #### 3.1.2 (2017-11-24)
@@ -29,0 +43,0 @@

package.json

 {
   "name": "kitsu",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "Simple & lightweight JSON-API client for Kitsu and other compliant APIs",
@@ -14,7 +14,7 @@ "license": "MIT",
     ":build": "jest && yarn build",
+    ":commit": "git add package.json && git add DOCS.md && git add CHANGELOG.md && git commit -m \"update changelog\"",
     ":publish": "git push origin && git push origin --tags && yarn publish",
-    ":commit": "git add package.json && git add DOCS.md && git add CHANGELOG.md && git commit -m \"update changelog\"",
-    ":major": "yarn :build && changelog -M && yarn :commit && yarn :publish",
-    ":minor": "yarn :build && changelog -m && yarn :commit && yarn :publish",
-    ":patch": "yarn :build && changelog -p && yarn :commit && yarn :publish",
+    ":major": "yarn :build && changelog -M && yarn :commit && npm version major && yarn :publish",
+    ":minor": "yarn :build && changelog -m && yarn :commit && npm version minor && yarn :publish",
+    ":patch": "yarn :build && changelog -p && yarn :commit && npm version patch && yarn :publish",
     "test": "jest --coverage",
@@ -73,8 +73,8 @@ "docs": "documentation build src/index.js -f md -o DOCS.md --sort-order alpha",
     "documentation": "~5.3.3",
-    "eslint": "~4.10.0",
-    "eslint-plugin-jest": "~21.2.0",
-    "generate-changelog": "~1.5.0",
+    "eslint": "~4.13.0",
+    "eslint-plugin-jest": "~21.4.0",
+    "generate-changelog": "~1.6.0",
     "jest": "~21.2.1",
     "js-beautify": "~1.7.4",
-    "rollup": "~0.50.0",
+    "rollup": "~0.52.0",
     "rollup-plugin-babel": "~3.0.1",
@@ -81,0 +81,0 @@ "rollup-plugin-babel-minify": "~3.1.2",

README.md

 # Kitsu
 
-[![npm]][1]
-[![npm installs]][1]
-[![David]][7]
+[![npm badge]][npm]
+[![npm install badge]][npm]
+[![david badge]][david]
+[![contributors badge]][contributors]
+[![donate badge]][donate]
 
-[![Travis]][2]
-[![AppVeyor]][3]
-[![CC Coverage]][4]
-[![CC Score]][5]
-[![CC Issues]][6]
+[![travis badge]][travis]
+[![appveyor badge]][appveyor]
+[![david dev badge]][david dev]
+[![cc maintainability badge]][cc maintainability]
+[![cc coverage badge]][cc coverage]
 
-Simple, lightweight & framework agnostic [JSON-API][15] client for [Kitsu.io][KITSU] and other API backends
+A Simple framework agnostic [JSON:API] client for [Kitsu.io] and other spec compliant APIs
 
-*For breaking changes in 3.0, check the [CHANGELOG][16]*
+*For breaking changes in 3.0, check the [CHANGELOG][BREAKING]*
 
@@ -20,4 +22,5 @@ ## Features
 - Fully JSON-API compliant
+- Automatically links relationships to data
 - Works in Node and on the web
-- Uses the [Promise][10] API
+- Uses the [Promise] API
 - Configurable timeout handling
@@ -39,2 +42,59 @@
 
+## Response Comparison
+
+A GET request to a JSON:API API returns:
+
+```json5
+{
+  data: [
+    {
+      id: '4923ee67-19b0-4093-8aee-ab6ceeecf784'
+      type: 'users'
+      attributes: {
+        name: 'wopian'
+      }
+      relationships: {
+        followers: {
+          data: [
+            {
+              id: '50cfe2db-8157-4999-be87-450fea1b4b52'
+              type: 'follows'
+            }
+          ]
+        }
+      }
+    }
+  ]
+  included: [
+    {
+      id: '50cfe2db-8157-4999-be87-450fea1b4b52'
+      type: 'follows'
+      attributes: {
+        createdAt: '2017-08-24T02:36:26.006Z'
+      }
+    }
+  ]
+}
+```
+
+A GET request made with `kitsu` returns:
+```json5
+{
+  data: [
+    {
+      id: '4923ee67-19b0-4093-8aee-ab6ceeecf784'
+      type: 'users'
+      name: 'wopian'
+      followers: [
+        {
+          id: '50cfe2db-8157-4999-be87-450fea1b4b52'
+          type: 'follows'
+          createdAt: '2017-08-24T02:36:26.006Z'
+        }
+      ]
+    }
+  ]
+}
+```
+
 ## Usage
@@ -87,9 +147,9 @@
 
-[More Examples][11]
+[More Examples]
 
 ## Docs
 
-You can find the kitsu package [documentation here][13]
+You can find the kitsu package [documentation here][Kitsu Docs]
 
-If you're working with [Kitsu.io][KITSU]'s API, their [API documentation][12] lists all available
+If you're working with [Kitsu.io]'s API, their [API documentation][Kitsu.io API Docs] lists all available
 models with their attributes and relationships
@@ -109,3 +169,10 @@
 
-[KITSU]:https://kitsu.io
+[Kitsu.io]:https://kitsu.io
+[JSON:API]:http://jsonapi.org
+[Promise]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
+[More Examples]:https://github.com/wopian/kitsu/tree/master/example
+[Kitsu Docs]:https://github.com/wopian/kitsu/tree/master/DOCS.md
+[Kitsu.io API Docs]:https://kitsu.docs.apiary.io
+
+[BREAKING]:https://github.com/wopian/kitsu/blob/master/CHANGELOG.md#breaking-changes
 [CHANGELOG]:https://github.com/wopian/kitsu-inactivity-pruner/blob/master/CHANGELOG.md
@@ -115,25 +182,26 @@ [CONTRIBUTING]:https://github.com/wopian/kitsu-inactivity-pruner/blob/master/CONTRIBUTING.md
 
-[npm]:https://img.shields.io/npm/v/kitsu.svg?style=flat-square
-[npm installs]:https://img.shields.io/npm/dt/kitsu.svg?style=flat-square
-[Travis]:https://img.shields.io/travis/wopian/kitsu/master.svg?style=flat-square&label=linux%20%26%20macOS
-[CC Coverage]:https://img.shields.io/codeclimate/coverage/github/wopian/kitsu.svg?style=flat-square
-[CC Score]:https://img.shields.io/codeclimate/github/wopian/kitsu.svg?style=flat-square
-[CC Issues]:https://img.shields.io/codeclimate/issues/github/wopian/kitsu.svg?style=flat-square
-[David]:https://img.shields.io/david/wopian/kitsu.svg?style=flat-square
-[AppVeyor]:https://img.shields.io/appveyor/ci/wopian/kitsu/master.svg?style=flat-square&label=windows
-[1]:https://www.npmjs.com/package/kitsu
-[2]:https://travis-ci.org/wopian/kitsu
-[3]:https://ci.appveyor.com/project/wopian/kitsu
-[4]:https://codeclimate.com/github/wopian/kitsu/coverage
-[5]:https://codeclimate.com/github/wopian/kitsu
-[6]:https://codeclimate.com/github/wopian/kitsu/issues
-[7]:https://david-dm.org/wopian/kitsu
-[8]:https://github.com/wopian/kitsu/blob/master/CHANGELOG.md
-[9]:https://github.com/wopian/kitsu/blob/master/LICENSE.md
-[10]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
-[11]:https://github.com/wopian/kitsu/tree/master/example
-[12]:http://docs.kitsu.apiary.io
-[13]:https://github.com/wopian/kitsu/tree/master/DOCS.md
-[14]:http://jsonapi.org/implementations/#client-libraries-javascript
-[15]:http://jsonapi.org
-[16]:https://github.com/wopian/kitsu/blob/master/CHANGELOG.md#breaking-changes
+[npm]:https://www.npmjs.com/package/kitsu
+[npm badge]:https://img.shields.io/npm/v/kitsu.svg?style=flat-square
+[npm install badge]:https://img.shields.io/npm/dt/kitsu.svg?style=flat-square
+
+[travis]:https://travis-ci.org/wopian/kitsu
+[travis badge]:https://img.shields.io/travis/wopian/kitsu/master.svg?style=flat-square&label=linux%20%26%20macOS
+
+[appveyor]:https://ci.appveyor.com/project/wopian/kitsu
+[appveyor badge]:https://img.shields.io/appveyor/ci/wopian/kitsu/master.svg?style=flat-square&label=windows
+
+[cc coverage]:https://codeclimate.com/github/wopian/kitsu/coverage
+[cc coverage badge]:https://img.shields.io/codeclimate/coverage/github/wopian/kitsu.svg?style=flat-square
+[cc maintainability]:https://codeclimate.com/github/wopian/kitsu
+[cc maintainability badge]:https://img.shields.io/codeclimate/maintainability/wopian/kitsu.svg?style=flat-square
+
+[david]:https://david-dm.org/wopian/kitsu
+[david badge]:https://img.shields.io/david/wopian/kitsu.svg?style=flat-square
+[david dev]:https://david-dm.org/wopian/kitsu?type=dev
+[david dev badge]:https://img.shields.io/david/dev/wopian/kitsu.svg?style=flat-square
+
+[contributors]:https://github.com/wopian/kitsu/graphs/contributors
+[contributors badge]:https://img.shields.io/github/contributors/wopian/kitsu.svg?style=flat-square
+
+[donate]:https://paypal.me/pools/c/7ZZSVeBON7
+[donate badge]:https://img.shields.io/badge/£-donate-ff69b4.svg?style=flat-square

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

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

101823

increased by3.07%

Number of medium maintenance alerts

0

decreased by-100%

Number of lines in readme file

203

increased by50.37%

No dependency changes