h5o - npm Package Compare versions

Comparing version 0.7.0 to 0.7.1

package.json

 {
   "name": "h5o",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "HTML5 outliner",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # HTML5 outliner #
+[![Build Status](https://travis-ci.org/h5o/h5o-js.svg?branch=master)](https://travis-ci.org/h5o/h5o-js)
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/h5o-js.svg)](https://saucelabs.com/u/h5o-js)
 
-This project originally lived on Google Code, and for the time being, 
-the downloads still reside there: https://code.google.com/p/h5o/downloads/list
+h5o is an implementation of the HTML5 outline algorithm in JavaScript. Specifications:
 
+* [W3C Recommendation 28 October 2014](http://www.w3.org/TR/html5/sections.html#outline)
+* [WHATWG Living Standard](https://html.spec.whatwg.org/multipage/semantics.html#outlines)
+
 If you like this tool, please consider [a charitable donation](https://www.ammado.com/community/112794) to Ocean Voyages Institute (Project Kaisei).
 
-## Real current status ##
+## Usage ##
 
-Kind of trying to revive this, clean up and create myself some space for experimentation.
+* [Chrome extension](https://chrome.google.com/extensions/detail/afoibpobokebhgfnknfndkgemglggomo) available
+    - Source: https://github.com/h5o/h5o-chrome
+* [Bookmarklet](http://h5o.github.io/h5o-js/outliner.html)
+* `npm install h5o` (as of 2015, you should not be using any other way of managing your JS dependencies)
+  - Use the UMD module available in `dist/outliner.min.js` with a fallback to global `HTML5Outline` or 
+    `var HTML5Outline = require('h5o')` in node or browserify
+  - `HTML5Outline(startFrom)` (you likely want `startFrom` to be `document.body`). Returned value is an outline object, with sections.
+  - `outline.asHTML(createLinks)` to get HTML with an ordered list. If `createLinks` is `true`, the DOM will be amended with IDs and the list will contain links for navigation
 
-* [List of cleanup tasks](https://github.com/h5o/h5o-js/issues?labels=cleanup&page=1&state=open)
+## Development ##
 
-Chrome Extension is now split out into a separate repo: https://github.com/h5o/h5o-chrome
+### Pre-requisites ###
+ 
+1. install [`node`](http://nodejs.org/) or [`iojs`](https://iojs.org/) (includes `npm`)
+2. `npm install -g grunt-cli`
+4. `npm install` in your local clone of this repo
 
-[![Build Status](https://travis-ci.org/h5o/h5o-js.svg?branch=master)](https://travis-ci.org/h5o/h5o-js)
-[![Sauce Test Status](https://saucelabs.com/browser-matrix/h5o-js.svg)](https://saucelabs.com/u/h5o-js)
+### Run tests locally ###
+Run `grunt test`
+* Will launch [buster](http://busterjs.org) server and capture a browser with it
+* Will run tests in node using [`jsdom`](https://www.npmjs.com/package/jsdom)
+* @todo: automatically run tests in phantom: https://github.com/h5o/h5o-js/issues/26
 
-### Running tests locally ###
-* start phantomjs webdriver server: `phantomjs --webdriver=4444`
-* `grunt test`
+Run `grunt start-dev`
+* Will watch for file changes and run tests automatically
 
-## Original README ##
+### Release ###
+Run `grunt release --bump=[patch|minor|major]`
+* Will bump version
+* Will tag the release
+* Will `npm publish`
+* Will push out an update `gh-pages`
 
-> The current (Nov, 2009) HTML5 draft defines quite a precise algorithm, for producing an outline for HTML documents. h5o is an implementation of the algorithm in JavaScript.
 
-> ### The goals of this project are: ###
+## History ##
 
-> * A bookmarklet, to produce outlines in decent browsers
-> * ~~A Firebug extension, to help HTML5 development~~
-> * A repository of HTML5 outlining test cases
+### v0.7.0 (2015-02-18) ###
+* Using browserify instead of concatenation
+* Making tests pass with jsdom
+* Updating browsers and dependencies
 
-> ### Downloads ###
+### v0.6.3 (2014-06-06) ###
+* Replacing inter with buster
 
-> [Chrome extension](https://chrome.google.com/extensions/detail/afoibpobokebhgfnknfndkgemglggomo) available
-> ~~[Bookmarklet](http://code.google.com/p/h5o/downloads/list) available (Tested in FF3.5 and O10.10 - should also work elsewhere)~~
->  - ~~Limited [version for IE](http://h5o.googlecode.com/files/bookmarklet.for.ie.html) also available. See: [ProblemsWithInternetExplorer]~~
-> ~~Firebug extension is in a very [early experimental state](http://code.google.com/p/h5o/downloads/list)~~
-> ~~[Minified JS](http://code.google.com/p/h5o/downloads/list) that you can use.~~ `npm install h5o`, use `dist/outliner.min.js`
-> - `HTML5Outline(startFrom)` (you likely want startFrom to be document.body). Returned value is an outline object, with sections.
-> - `outline.asHTML(createLinks)` to get a simple ordered list. If createLinks is true, the DOM will be amended with IDs and the list will contain links for navigation
+### v0.6.2 (2014-06-05) ###
+* Using ejs to generate bookmarklet HTML
+* Using gh-pages to publish the bookmarklet
+
+### v0.6.0 (2014-06-04) ###
+* Using intern
+* Using SauceLabs
+* Using travis
+
+### v0.5.4 (2014-06-02) ###
+* Rewritten build scripts with [`grunt`](http://gruntjs.com)
+* Split away Chrome extension, removed Opera/Firefox extension code
+
+### v0.5.2 (2014-06-01) ###
+* First version published in npm
+
+### v0.5.1 and earlier ###
+Originally [lived on Google Code](https://code.google.com/p/h5o), if you like archeology 

Fixed 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

Improved metrics

Number of lines in readme file

76

increased by80.95%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

78414

decreased by-16.56%

Number of package files

45

decreased by-6.25%

Lines of code

910

decreased by-1.09%

No dependency changes