hellosign-embedded
Advanced tools
hellosign-embedded - npm Package Compare versions
Comparing version 0.1.9 to 1.0.0
| { | ||
| "name": "hellosign-embedded", | ||
| "version": "0.1.9", | ||
| "version": "1.0.0", | ||
| "description": "A JavaScript library required for embedding HelloSign features into your webapp. For more information, see our API documentation at https://www.hellosign.com/api/documentation.", | ||
| "main": "src/embedded.js", | ||
| "scripts": { | ||
| "test": "mocha tests/module.js" | ||
| "test": "mocha tests/module.js", | ||
| "start": "scripts/start.sh" | ||
| }, | ||
@@ -25,4 +26,5 @@ "repository": { | ||
| "mocha": "^2.4.5", | ||
| "uglify-loader": "^1.3.0" | ||
| "uglify-loader": "^1.3.0", | ||
| "webpack": "^1.13.0" | ||
| } | ||
| } |
@@ -8,6 +8,23 @@ # hellosign-embedded [](https://travis-ci.org/HelloFax/hellosign-embedded) | ||
| You can include this library in your projects in one of three ways: | ||
| * [From our CDN](#loading-from-cdn) | ||
| * [NPM, for bundling with webpack, etc.](#npm) | ||
| * [Linked in page from our CDN](#loading-from-cdn) | ||
| * [Built from source](#building-from-source) | ||
| * [Bundled with webpack, etc.](#webpack) | ||
| ###NPM | ||
| You can require the hellosign-embedded package in your front-end code when using a bundler like [browserify](http://browserify.org/) or [webpack](https://webpack.github.io/). | ||
| First, `npm install hellosign-embedded` to add to your `node_modules` directory, then attach to a variable or the global window: | ||
| ````javascript | ||
| window.HelloSign = require('hellosign-embedded'); | ||
| ```` | ||
| If transpiling for ES6, you can also use the `import` statement: | ||
| ````javascript | ||
| import HelloSign from 'hellosign-embedded'; | ||
| window.HelloSign = HelloSign; | ||
| ```` | ||
| ###Loading from CDN | ||
@@ -27,3 +44,5 @@ | ||
| ```` | ||
| We highly recommend using the latest version of the library, so you'll receive security and feature updates. | ||
| ###Building from source | ||
@@ -49,17 +68,2 @@ You'll need to clone this repository, and have [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm) and [webpack](https://webpack.github.io/) installed. | ||
| ###Webpack | ||
| You can require the hellosign-embedded package in your front-end code when using a bundler like browserify or [webpack](https://webpack.github.io/). | ||
| First, `npm install hellosign-embedded` to add to your `node_modules` directory, then attach to a variable or the global window: | ||
| ````javascript | ||
| window.HelloSign = require('hellosign-embedded'); | ||
| ```` | ||
| If transpiling for ES6, you can also use the `import` statement: | ||
| ````javascript | ||
| import HelloSign from 'hellosign-embedded'; | ||
| window.HelloSign = HelloSign; | ||
| ```` | ||
| ##Usage | ||
@@ -88,1 +92,12 @@ | ||
| Tests are a work in progress, built with Mocha and [Chai](http://chaijs.com/), and using [jsdom-global](https://github.com/rstacruz/jsdom-global) | ||
| ##Demo | ||
| There is a demo app available in this repo, useful for both development against this repo, and examining how a simple integration can work. | ||
| You can start the test server from the root of the repository by simply running | ||
| ````sh | ||
| npm start | ||
| ```` | ||
| When running, any changes to `src/embedded.js` will be tracked, and the file that the demo site uses will be rebuilt on the fly. | ||
| You'll need an API Key and Client ID for HelloSign's API to use this demo application. |
@@ -389,17 +389,3 @@ /** | ||
| // FIXME: Temporary parameter to log which version of embedded.js is being used | ||
| // FIXME: Remove the code that processes the js_version in editor actions when | ||
| // this is removed. | ||
| var js_version = 'latest'; | ||
| var scripts = document.getElementsByTagName('script'); | ||
| for (var script_i = 0; script_i < scripts.length; script_i++) { | ||
| var node_src = scripts[script_i].src; | ||
| if (node_src.indexOf('embedded.js') > 0) { | ||
| var matches = node_src.match(/(1\.\d{2}\.\d+)/); | ||
| if (matches && matches.length > 0) { | ||
| js_version = matches[0]; | ||
| } | ||
| } | ||
| } | ||
| frameUrl += '&js_version=' + js_version; | ||
| frameUrl += '&js_version=' + this.VERSION; | ||
@@ -406,0 +392,0 @@ var origin = frameUrl.replace(/([^:]+:\/\/[^\/]+).*/, '$1'); |
@@ -48,2 +48,2 @@ var version = require('./package.json').version; | ||
| } | ||
| ] | ||
| ]; |
Sorry, the diff of this file is not supported yet
New alerts
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
Fixed alerts
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
No v1
QualityPackage 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
- increased by40.27%
71645
- Number of package files
- increased by58.33%
19
- Lines of code
- increased by10.07%
1049
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by17.65%
100
Worsened metrics
- Dev dependency count
- increased by16.67%
7