Merge pull request #7 from Brightspace/upgrade-deps-node-docs

upgrading to latest node and dependencies

.npmignore

@@ -1,10 +1,7 @@
+.csslintrc
 .editorconfig
 .gitattributes
 .gitignore
 .npmignore
 .travis.yml
-.csslintrc
 node_modules
-karma.conf.js
-test
-offscreen.css.scss

.travis.yml

@@ -1,12 +1,12 @@
-language: node_js
-node_js:
-- '0.12'
-sudo: false
-deploy:
-  provider: npm
-  email: [email protected]
-  api_key:
-    secure: hE32yp/q/3GHwuoFzN/XIqbp62Xt+8CKuokMKF9umEdIB+4Nlz/tCqUcIRBKZWCYdUF6RqtvbmG7MhmjW1VB3eLIsP8zcyHf7ddNG26cjAs3xVq2or1yHQVgl1jojDgaOMeLXUAa5d2jOkLa8KzoqanrmqsYNRwgfRUP0chTM28=
-  on:
-    tags: true
-    all_branches: true
+language: node_js
+node_js:
+- 5.6
+sudo: false
+deploy:
+  provider: npm
+  email: [email protected]
+  api_key:
+    secure: hE32yp/q/3GHwuoFzN/XIqbp62Xt+8CKuokMKF9umEdIB+4Nlz/tCqUcIRBKZWCYdUF6RqtvbmG7MhmjW1VB3eLIsP8zcyHf7ddNG26cjAs3xVq2or1yHQVgl1jojDgaOMeLXUAa5d2jOkLa8KzoqanrmqsYNRwgfRUP0chTM28=
+  on:
+    tags: true
+    all_branches: true

LICENSE

@@ -176,7 +176,7 @@ recommend that a file or class name and description of purpose be included on
 the same "printed page" as the copyright notice for easier identification within
 third-party archives.
 
-Copyright 2014 D2L Corporation
+Copyright 2016 D2L Corporation
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -1,15 +1,57 @@
 # vui-offscreen
+[![Bower version][bower-image]][bower-url]
 [![NPM version][npm-image]][npm-url]
 [![Build status][ci-image]][ci-url]
 [![Dependency Status][dependencies-image]][dependencies-url]
 
-This component contains Sass mixins and CSS for positioning elements off the screen. Off-screen elements are valuable from an accessibility perspective when you wish to have elements which are only visible to screen readers. For more information, read [WebAIM's article on Invisible Content](http://webaim.org/techniques/css/invisiblecontent/).
+This component contains [SASS mixins](http://sass-lang.com/) and CSS wich can be used to position elements off the screen in an accessible manor.
 
-For further information on this component and other VUI components, see the docs at [ui.valence.d2l.com](http://ui.valence.d2l.com/).
+For further information on this and other VUI components, see the docs at [ui.valence.d2l.com](http://ui.valence.d2l.com/).
+
+## Installation
+
+`vui-offscreen` can be installed from [Bower][bower-url]:
+```shell
+bower install vui-offscreen
+```
+
+Or alternatively from [NPM][npm-url]:
+```shell
+npm install vui-offscreen
+```
+
+Depending on which installation method you choose, use that path when doing the SASS import:
+
+```scss
+@import 'bower_components/vui-offscreen/offscreen.scss';
+// or...
+@import 'node_modules/vui-offscreen/offscreen.scss';
+```
+
+## Usage
+
+Off-screen elements are valuable from an accessibility perspective when you wish to use elements which are only visible to screen readers. For more information, read [WebAIM's article on Invisible Content](http://webaim.org/techniques/css/invisiblecontent/).
+
+To position an element offscreen, apply the `vui-offscreen()` mixin using any  CSS selector.
+
+For example, to hide this message:
+```html
+<p class="offscreen">This message will only be visible to assistive technology, such as a screen reader.</p>
+```
+
+SCSS:
+```scss
+.offscreen {
+	@include vui-offscreen();
+}
+```
+
+## Coding styles
 
-#### Coding styles
 See the [VUI Best Practices & Style Guide](https://github.com/Brightspace/valence-ui-docs/wiki/Best-Practices-&-Style-Guide) for information on VUI naming conventions, plus information about the [EditorConfig](http://editorconfig.org) rules used in this repo.
 
+[bower-url]: http://bower.io/search/?q=vui-offscreen
+[bower-image]: https://img.shields.io/bower/v/vui-offscreen.svg
 [npm-url]: https://npmjs.org/package/vui-offscreen
 [npm-image]: https://img.shields.io/npm/v/vui-offscreen.svg
 [ci-image]: https://travis-ci.org/Brightspace/valence-ui-offscreen.svg?branch=master

package.json

@@ -26,7 +26,7 @@
   "homepage": "https://github.com/Brightspace/valence-ui-offscreen",
   "devDependencies": {
     "csslint": "^0.10.0",
-    "node-sass": "^3.1.1",
-    "rimraf": "^2.3.4"
+    "node-sass": "^3.4.2",
+    "rimraf": "^2.5.1"
   }
 }