bootstrap-tour - npm Package Compare versions

Comparing version 0.9.6 to 0.10.0

package.json

 {
   "name": "bootstrap-tour",
-  "description": "Quick and easy product tours with Twitter Bootstrap Popovers",
-  "version": "0.9.6",
-  "homepage": "https://github.com/FGRibreau/bootstrap-tour",
-  "author": "Francois-Guillaume Ribreau <[e-mail]> (http://fgribreau.com)",
+  "description": "Quick and easy way to build your product tours with Bootstrap Popovers.",
+  "version": "0.10.0",
+  "keywords": [
+    "tour",
+    "bootstrap",
+    "js",
+    "tour",
+    "intro"
+  ],
+  "homepage": "http://bootstraptour.com",
+  "author": {
+    "name": "Ulrich Sossou",
+    "email": "[e-mail]",
+    "url": "http://ulrichsossou.com"
+  },
+  "contributors": [
+    {
+      "name": "Emanuele Marchi",
+      "email": "[e-mail]",
+      "url": "http://lostcrew.it"
+    },
+    {
+      "name": "Nicola Molinari",
+      "email": "[e-mail]"
+    }
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/FGRibreau/bootstrap-tour.git"
+    "url": "https://github.com/sorich87/bootstrap-tour.git"
   },
   "bugs": {
-    "url": "https://github.com/FGRibreau/bootstrap-tour/issues"
+    "url": "https://github.com/sorich87/bootstrap-tour/issues"
   },
   "licenses": [
     {
-      "type": "MIT",
-      "url": "https://github.com/FGRibreau/bootstrap-tour/blob/master/LICENSE-MIT"
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
     }
   ],
-  "main": "lib/bootstrap-tour",
+  "dependencies": {
+    "bootstrap": "~3",
+    "jquery": ">=1.8"
+  },
+  "devDependencies": {
+    "coffee-script": "~1.7.1",
+    "gulp": "~3.8.6",
+    "gulp-bump": "^0.1.11",
+    "gulp-changed": "~0.4.1",
+    "gulp-clean": "~0.3.1",
+    "gulp-coffee": "~2.1.1",
+    "gulp-coffeelint": "~0.3.3",
+    "gulp-concat": "~2.3.4",
+    "gulp-connect": "~2.0.6",
+    "gulp-header": "~1.0.5",
+    "gulp-jasmine": "~0.3.0",
+    "gulp-karma": "0.0.4",
+    "gulp-less": "~1.3.2",
+    "gulp-load-plugins": "~0.5.3",
+    "gulp-open": "~0.2.8",
+    "gulp-rename": "~1.2.0",
+    "gulp-uglify": "~0.3.1",
+    "gulp-util": "~3.0.0",
+    "karma": "~0.12.19",
+    "karma-firefox-launcher": "~0.1.3",
+    "karma-jasmine": "~0.1.5",
+    "streamqueue": "0.1.1"
+  },
   "engines": {
-    "node": ">= 0.6.0"
+    "node": ">= 0.8.0"
   },
+  "main": [
+    "./build/js/bootstrap-tour.js",
+    "./build/js/bootstrap-tour-standalone.js",
+    "./build/css/bootstrap-tour.css",
+    "./build/css/bootstrap-tour-standalone.css"
+  ],
   "scripts": {
-    "test": "grunt test"
-  },
-  "devDependencies": {
-    "grunt": "~0.3.15",
-    "coffee-script": "~1.4.0",
-    "grunt-coffee": "0.0.6",
-    "dox": "~0.4.1",
-    "grunt-shell": "~0.1.4",
-    "doxx": "~0.5.7"
-  },
-  "keywords": []
+    "build": "gulp dist",
+    "test": "gulp test"
+  }
 }

README.md

@@ -1,41 +0,77 @@
-Bootstrap Tour Extended
-------------
+# Bootstrap Tour
+[![Build Status](http://img.shields.io/travis/sorich87/bootstrap-tour.svg?style=flat)](https://travis-ci.org/sorich87/bootstrap-tour)
+[![Dependency Status](http://img.shields.io/david/sorich87/bootstrap-tour.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour)
+[![devDependency Status](http://img.shields.io/david/dev/sorich87/bootstrap-tour/dev-status.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour#info=devDependencies)
+[![NPM Version](http://img.shields.io/npm/v/bootstrap-tour.svg?style=flat)](https://www.npmjs.org/)
 
-## [Documentation](http://fgribreau.github.com/bootstrap-tour/docs/bootstrap-tour.js.html)
+Quick and easy way to build your product tours with Bootstrap Popovers.
 
-### Improvement
-- `Tour` constructor now accept a `template` attribute thus the `labels.*` attribute has been removed.
-- `Tour` now emits an `skip(step)` event when skipping a step because the element is not visible.
-- `next()` and `prev()` return promise that is resolved when the popover is shown and that all callbacks have been executed
-- If `onShow` (at the `step` level or `Tour` level) returns a promise (see [$.Deferred()](http://api.jquery.com/category/deferred-object/)), Bootstrap-tour will wait until the completition of the promise(s) before displaying the popover
-- Persistence option `Memory`, `Cookie`, `LocalStorage` via constructor `new Tour({persistence:"LocalStorage"})`
-- `onHide`, `onShow` and `onShown` callbacks now have a second argument `Event` with
-  - `{String}` `Event.trigger`:: `api | popover | reflex`
-  - `{jQuery}` `Event.element`: the current step element (`onShow` Event does not provides the `element attribute use `onShown` instead)
-- `addStep` now accept a function as `element`
-- `addStep` and `Tour` constructor now accept `addClass` string attribute, the specified css class will then be added to the popover element
-- the popover element now have an automatically added `{tour.name}-step{step.index}` css class
+*Compatible with Bootstrap >= 2.3.0*
 
-### Bug fix
-- In `reflex` mode, leave the same css pointer as it was.
-- Don't create unnecessary $() objects
-- Remove event handlers after each step when `reflex:true`
-- `onHide`, `onShow`, `onShown` callbacks at the step level should not override `onHide`, `onShow`, `onShown` at the tour level
+## Demo and Documentation
+[http://bootstraptour.com](http://bootstraptour.com)
 
-## NPM
-Install with `npm install bootstrap-tour`
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Gulp](http://gulpjs.com/).
 
-## Release History
-v0.1.0 - Initial commit
+Feel free to contribute with pull requests, bug reports or enhancement suggestions.
 
-## License
-Copyright (c) 2013 FG Ribreau
-Licensed under the MIT, GPL licenses.
+We use [Gulp](http://gulpjs.com/) and [Jasmine](http://pivotal.github.io/jasmine/). Both make your life easier ;)
 
-## Contributing
-In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt).
+### Develop
 
-### Important notes
-Please don't edit files in the `dist` subdirectory as they are generated via grunt. You'll find source code in the `src` subdirectory!
+Files to be developed are located under `./src/`.
+Compiled sources are then automatically put under `./build/`, `./test/` and `./docs/`.
 
-While grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the `test/*.html` unit test file(s) in _actual_ browsers.
+#### Requirements
+
+To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, npm, and grunt's command line runner:
+
+##### Linux
+
+```bash
+$ sudo apt-get install ruby
+$ sudo apt-get install ruby-dev
+$ sudo apt-get install npm
+$ sudo apt-get install nodejs-legacy
+```
+
+##### Mac OS X
+
+```bash
+ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
+\curl -L https://get.rvm.io | bash
+rvm install ruby-2.1.1
+brew install node
+```
+
+##### Development requirements
+
+```bash
+$ npm install -g gulp
+$ npm install
+$ gem install jekyll
+```
+
+For Mac OS X Mavericks (10.9) users: You will need to [jump through all these hoops](http://dean.io/setting-up-a-ruby-on-rails-development-environment-on-mavericks/) before you can install Jekyll.
+
+#### Gulp usage
+
+Run gulp and start to develop with ease:
+
+```bash
+$ gulp
+$ gulp dist
+$ gulp test
+$ gulp docs
+$ gulp clean
+$ gulp server
+$ gulp bump --type minor (major.minor.patch)
+```
+
+Check `gulpfile.coffee` to know more.
+
+## License
+
+Code licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
+Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

857964

14.4%

Number of downloads

4401

4.66%

Number of package files

51

70%

Number of low license alerts

0

-100%

License quality

100

42.86%

Number of lines in readme file

78

85.71%

Number of low supply chain risk alerts

0

-100%

Worsened metrics

Dependency count

2

Infinity%

Dev dependency count

22

266.67%

Lines of code

12047

-37.53%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  bootstrap@~3

• + Added

  jquery@>=1.8

• + Added

  bootstrap@3.4.1
  (transitive)

• + Added

  jquery@3.7.1
  (transitive)