diff options
Diffstat (limited to 'node_modules/is-odd/README.md')
| -rw-r--r-- | node_modules/is-odd/README.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/node_modules/is-odd/README.md b/node_modules/is-odd/README.md new file mode 100644 index 000000000..514db35dc --- /dev/null +++ b/node_modules/is-odd/README.md @@ -0,0 +1,80 @@ +# is-odd [](https://www.npmjs.com/package/is-odd) [](https://npmjs.org/package/is-odd) [](https://npmjs.org/package/is-odd) [](https://travis-ci.org/jonschlinkert/is-odd) + +> Returns true if the given number is odd. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save is-odd +``` + +## Usage + +```js +var isOdd = require('is-odd'); + +isOdd(0); +//=> false +isOdd('1'); +//=> true +isOdd(2); +//=> false +isOdd('3'); +//=> true +``` + +## About + +### Related projects + +* [exponential-moving-average](https://www.npmjs.com/package/exponential-moving-average): Calculate an exponential moving average from an array of numbers. | [homepage](https://github.com/jonschlinkert/exponential-moving-average "Calculate an exponential moving average from an array of numbers.") +* [is-even](https://www.npmjs.com/package/is-even): Return true if the given number is even. | [homepage](https://github.com/jonschlinkert/is-even "Return true if the given number is even.") +* [sma](https://www.npmjs.com/package/sma): Calculate the simple moving average of an array. | [homepage](https://github.com/doowb/sma "Calculate the simple moving average of an array.") + +### Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 8 | [jonschlinkert](https://github.com/jonschlinkert) | +| 2 | [noformnocontent](https://github.com/noformnocontent) | +| 1 | [Semigradsky](https://github.com/Semigradsky) | + +### Building docs + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb +``` + +### Running tests + +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: + +```sh +$ npm install && npm test +``` + +### Author + +**Jon Schlinkert** + +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) + +### License + +Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 27, 2017._
\ No newline at end of file |