build-url - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

bower.json

@@ -43,3 +43,3 @@ {
   ],
-  "version": "1.0.5"
+  "version": "1.0.6"
 }

package.json

 {
   "name": "build-url",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A small library that builds a URL given it's components",
@@ -5,0 +5,0 @@ "main": "./dist/build-url.js",

README.md

@@ -7,15 +7,59 @@ # build-url
 
-## Usage
+## Installation
 
+To install with bower:
 ```
+bower install build-url --save
+```
+
+To install with npm:
+
+```
 npm install build-url --save
 ```
 
-If using node:
+## Usage
 
+Usage in the browser:
+
 ```
+<script src="../path/to/lib/build-url.js"></script>
+<script>
+buildUrl('http://example.com', {
+  path: 'about',
+  hash: 'contact',
+  queryParams: {
+    foo: bar,
+    bar: ['foo', 'bar']
+  }
+});
+</script>
+```
+
+Usage with ES6 modules:
+```
+import buildUrl from '../path/to/lib/build-url';
+
+buildUrl('http://example.com', {
+  path: 'about',
+  hash: 'contact',
+  queryParams: {
+    foo: bar,
+    bar: ['foo', 'bar']
+  }
+});
+```
+
+Usage with node:
+
+```
 var buildUrl = require('build-url');
 
 buildUrl('http://example.com', {
-  path: 'about'
+  path: 'about',
+  hash: 'contact',
+  queryParams: {
+    foo: bar,
+    bar: ['foo', 'bar']
+  }
 });
@@ -22,0 +66,0 @@ ```

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

11033

increased by6.09%

Number of lines in readme file

100

increased by78.57%

No dependency changes