promise-window - npm Package Compare versions

Comparing version 0.3.5 to 1.0.0

package.json

 {
   "name": "promise-window",
-  "version": "0.3.5",
+  "version": "1.0.0",
   "description": "Lightweight wrapper around window.open() that adds Promise and postMessage support",
@@ -16,4 +16,4 @@ "keywords": [
   "bugs": {
-    "url" : "https://github.com/amercier/promise-window/issues",
-    "email" : "[e-mail]"
+    "url": "https://github.com/amercier/promise-window/issues",
+    "email": "[e-mail]"
   },
@@ -31,2 +31,3 @@ "license": "MIT",
   "scripts": {
+    "dependencies": "bower install",
     "clean": "for dir in docs/.git docs/api docs/bower_components tests/coverage; do [ ! -e $dir ] || rm -rf $dir || exit 1; done",
@@ -37,3 +38,3 @@ "lint": "jshint --reporter node_modules/jshint-stylish/stylish.js .",
     "report": "istanbul report && cat tests/coverage/summary.txt && echo",
-    "test": "npm run lint && npm run clean && for suite in $([ \"$SUITE\" = \"\" ] && npm run -s list || echo $SUITE); do SUITE=$suite CI=true npm run tdd || exit 1; done && npm run report",
+    "test": "npm run lint && npm run clean && for suite in $([ \"$KARMA_ENV\" = \"\" ] && npm run -s list || echo $KARMA_ENV); do KARMA_ENV=$suite CI=true npm run tdd || exit 1; done && npm run report",
     "build": "gulp build",
@@ -40,0 +41,0 @@ "docs": "(cd docs && bower install --production) && jsduck src/ --output docs/api --warnings-exit-nonzero",

README.md

@@ -7,2 +7,3 @@ promise-window
 [![Latest Stable Version](https://img.shields.io/bower/v/promise-window.svg?style=flat-square)](http://bower.io/search/?q=promise-window)
+[![Latest Stable Version](https://img.shields.io/npm/v/promise-window.svg?style=flat-square)](https://www.npmjs.com/package/promise-window)
 [![Build Status](https://img.shields.io/travis/amercier/promise-window/master.svg?style=flat-square)](https://travis-ci.org/amercier/promise-window)
@@ -12,1 +13,121 @@ [![Code Climate](https://img.shields.io/codeclimate/github/amercier/promise-window.svg?style=flat-square)](https://codeclimate.com/github/amercier/promise-window)
 [![Dependency Status](http://img.shields.io/gemnasium/amercier/promise-window.svg?style=flat-square)](https://gemnasium.com/amercier/promise-window)
+
+[![PromiseWindow](https://cloud.githubusercontent.com/assets/1246795/6099683/cdd9e59c-afb3-11e4-92a3-f1688990984f.png)](http://amercier.github.io/promise-window/)
+
+[Live example](http://amercier.github.io/promise-window/)
+
+
+Installation
+------------
+
+### Bower (recommended) ###
+
+    bower install promise-window --save-dev
+
+### NPM ###
+
+    npm install promise-window --save-dev
+
+### Manuall installation ###
+
+Grab a copy of [promise-window](https://raw.githubusercontent.com/amercier/promise-window/master/dist/promise-window.min.js)
+([development version](https://raw.githubusercontent.com/amercier/promise-window/master/dist/promise-window.js)).
+
+
+Usage
+-----
+
+The simplest way to use PromiseWindow is to use the `PromiseWindow.open`
+convenience method:
+
+```javascript
+/**
+ * index.html
+ */
+PromiseWindow.open('http://popup.html').then(
+  
+  // Success
+  function(data) {
+    // data.result == 'awesome' (1)
+  },
+
+  // Error
+  function(error) {
+    switch(error) {
+      case 'closed':
+        // window has been closed
+        break;
+      case 'my-custom-message':
+        // 'my-custom-message' postMessage has been sent from target URL (2)
+        break;
+    }
+  }
+);
+```
+
+```javascript
+/**
+ * popup.html
+ */
+
+// report succees
+opener.postMessage({ result: 'yeah' }, location.origin); // (1)
+
+// report error
+opener.postMessage({ error: 'my-custom-message' }, location.origin); // (2)
+```
+
+
+### Advanced usage ###
+
+Instanciating the `PromiseWindow` prototype gives you more control. The
+following example shows how to close the window after 30 seconds.
+
+```javascript
+var promiseWindow = new PromiseWindow('http://popup.html'),
+    timeout = window.setTimeout(function() {
+      promiseWindow.close();
+    }, 30000);
+
+promiseWindow.open().then(
+  function(data) {
+    window.clearTimeout(timeout);
+    // ... (success)
+  },
+  function(error) {
+    window.clearTimeout(timeout);
+    // ... (error)
+  }
+);
+```
+
+See [API Documentation](http://amercier.github.io/promise-window/api/#!/api/PromiseWindow)
+for more information about the `PromiseWindow` prototype.
+
+
+Authors
+-------
+
+- [Alex Mercier](https://amercier.com/)
+
+
+Versioning
+----------
+
+This library follows [Semantic Versioning](http://semver.org)
+
+
+Want to help?
+-------
+
+Please do! We are always looking to improve this component. Please see our
+[Contribution Guidelines](https://github.com/amercier/promise-window/blob/master/CONTRIBUTING.md)
+on how to properly submit issues and pull requests.
+
+
+Legal
+-----
+
+[Alex Mercier](https://amercier.com/) © 2015
+
+[Licensed under the MIT license](http://opensource.org/licenses/MIT)

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21480

increased by14.87%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

132

increased by1100%

No dependency changes