Comparing version 0.3.22 to 0.4.0
{ | ||
"name": "hubkit", | ||
"version": "0.3.22", | ||
"version": "0.4.0", | ||
"homepage": "https://github.com/pkaminski/hubkit", | ||
@@ -5,0 +5,0 @@ "authors": [ |
{ | ||
"name": "hubkit", | ||
"version": "0.3.22", | ||
"version": "0.4.0", | ||
"description": "GitHub API library for JavaScript, promise-based, for both NodeJS and the browser", | ||
@@ -25,3 +25,3 @@ "main": "index.js", | ||
"engines": { | ||
"node": ">=0.12" | ||
"node": ">=4.0" | ||
}, | ||
@@ -28,0 +28,0 @@ "dependencies": { |
@@ -6,6 +6,8 @@ hubkit | ||
* Takes a request-level approach that naturally covers the entire GitHub v3 API. | ||
* All requests return promises. (You may need to add a polyfill in the browser, depending on your target platforms. The Node package includes a polyfill in case you're not running with `--harmony`.) | ||
* All requests return promises. (You may need to add a polyfill in the browser, depending on your target platforms.) | ||
* Responses are (optionally) cached (segregated by user identity), and requests are conditional to save on bandwidth and request quota. | ||
Inspired by [simple-github](https://github.com/tobie/simple-github), [octo](https://github.com/Caged/octo), and [octokit](https://github.com/philschatz/octokit.js). | ||
#### Integration and dependencies | ||
To enable caching, make sure that [LRUCache](https://github.com/isaacs/node-lru-cache) is | ||
@@ -17,2 +19,6 @@ loaded. It's installed by default for Node, but in the browser you need to load `lru-cache.js` | ||
If you're fetching Hubkit via Bower, note that the `superagent` dependency _does not ship with browser-ready code_. You'll need to make a dist build yourself via Browserify. Ironically, the `npm` package for `superagent` does include browser-ready code. | ||
#### Usage | ||
A simple example: | ||
@@ -61,2 +67,4 @@ | ||
#### Options reference | ||
Valid options to pass (to the constructor or to each request), or to set on `Hubkit.defaults`, | ||
@@ -63,0 +71,0 @@ include: |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
30007
109