Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.84 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.84 KB

js-colors logo

js-colors

JavaScript color manipulation library. It is a library that is designed and built to do everything you could ever want to do with a color in your browser.

This page is dedicated to everything development related. For documentation, please visit the js-colors website!

installing

Since it's in bower, it is really simple.

bower install js-colors

If you don't want to use bower (even though it is really awesome), you can download a precompiled release directly from the js-colors website in the downloads section.

development

I love to have people help me write software. Please submit a pull request as long as the following is true:

  1. Code coverage is still at 100%
  2. You have at least one test for each bit of your added functionality
  3. You update the documentation accordingly
  4. It still passes eslint

If you can't meet (or don't know how) to satisfty the above conditions, don't worry, it's collaborative, we can do it together!

contributing

  1. Install all of the dependencies (luckily npm makes this really easy)

     npm install
    
  2. Edit what you need to in colors.js

  3. Make sure tests pass

     karma start
    
  4. Inspect code coverage report at: js-colors/coverage//index.html and make sure it is still at 100% across the board.

  5. Make sure eslint passes

     eslint colors.js
    
  6. Submit your pull request

  7. Discussion

  8. YAY! Thanks for contributing!

license

It's MIT License. Do whatever you want really. Though I do love to know who is using it so feel free to drop me a line!

inspiration

I'd like to thank mexitek for the idea. You can find him at https://github.com/mexitek