hotchocjs v1.0.5

HotChocJS

HotChocJS is a tool for dimming your website so your viewers can sit back, relax and have a hot chocolate while not being blinded by their computer.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Node.js & npm.js

Installing

Lets start by installing Node if you haven't already. Download at: https://nodejs.org/en/download/

Now use NPM to install HotChocJS.

npm install hotchocjs

Alternatives

Incase you do not wish to deal with node much or the node modules folder, I have prepared a bower package for you: to get the package: type bower install hotchocjs

Built With

• Jquery - The Javascript framework used
• SizzleJS - Javascript Selector Library
• Node - Dependency Creation
• NPM - Dependency Publishing
• Bower - Dependency Creation, Publishing
• GitLab - Dependency Management

Contributing

Please see: CONTRIBUTING.MD If you would like to contibute to the development of HotChocJS, please create pull requests.

Versioning

For the versions available, see the tags on this repository.

Authors

• Christian Barton Randall - Main Code - Pigcake999
• Javier Sierra - Help with development. - Sierrica

License

This project is licensed under the Apache Liscene 2.0- see the LICENSE.txt file for details

Acknowledgments

• JS Foundation for Jquery,
• My Burning eyes looking at a computer screen at night,
• My family for pushing me along :)