debunk: A JavaScript repository from baconsaur

#DeBunk

1. Synopsis
2. Installation
3. Examples
3.1. Example 1
3.2. Example 2
3.3. Example 3 3.4. Example 3 3.5. Example 3 3.6. Example 3
4. Testing
5. Why DeBunk
5.1. Compare us to Our Competitors
5.2. What Does Shibley Have to Say?
5.3. Concerning performance
6. Contributions
7. License

##1. Synopsis DeBunk is a highly performant, state-of-the-art 3 and/or 17 verifier.

##2. Installation

You can install DeBunk with npm:

npm install debunk

##3. Examples

Here are some examples of how to use DeBunk.

###3.1. Example 1

var debunk = require('debunk');
debunk.whatDoesThreeEqual(); //3

###3.2. Example 2

var debunk = require('debunk');
debunk.whatDoesSeventeenEqual(); //17

###3.3. Example 3

var debunk = require('debunk');
debunk.whatDoesThreeEqual() * debunk.whatDoesSeventeenEqual(); //51

###3.4. Example 4

var debunk = require('debunk');
debunk.whatProbablyDoesNotEqualSeventeen() //Random number between 1 and 1,000. Could be 17 though, who knows.

###3.5. Example 5

var debunk = require('debunk');
debunk.whatDoesSeventeenNotEqual(); //Returns 9, because seventeen does not equal 9.

###3.6. Example 6

var debunk = require('debunk');
debunk.whatDoesShibleyHaveToSay(); // "Right on"

##4. Testing

Tests are not included in the DeBunk repo to cut down on bloated module sizes. It is, however, important to test your code. DeBunk is compliant with all major testing frameworks. Here is an example for writing tests to make sure DeBunk is behaving properly.

var debunk = require('debunk');
var testPassed = debunk.whatDoesThreeEqual() === 3;
var otherTestPassed = debunk.whatDoesSeventeenEqual() === 17;

##5. Why DeBunk

The main reason why I wrote DeBunk was to solve the recurring need to establish a verifiable value for 3 and/or 17. As I'm sure you've experienced in your coding career, functionally determining the value of 3 and/or 17 can be quite cumbersome. I hope DeBunk can alleviate your coding woes.

###5.1. Compare us to Our Competitors

Not conviced that DeBunk is heads above the competitors. Download it and try us out. If you're not 123% satisfied, we will triple your money back. That's how much we believe in our project.

###5.2. What Does Shibley Have to Say?

"Interesting. Have you noticed that I eat a lot? Let's play ping pong."

###5.3. Concerning performance

DeBunk is the most performant piece of 3 and/or 17 value verifier on the market today. Our engineers are always working with new technologies to keep ahead of the advances in technology.

##6. Contributions DeBunk is open source. Contribute today at http://www.github.com/skuttleman/debunk!

##7. License

ISC Lisense

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

baconsaur/debunk