1 | # Extended Math
|
2 |
|
3 | [![NPM version][npm-version-image]][npm-url]
|
4 | [![Build Status][build-status-image]][build-status-url]
|
5 | [![Coverage Status][coverage-image]][coverage-url]
|
6 | [![Known Vulnerabilities][vulnerabilities-image]][vulnerabilities-url]
|
7 | [![Downloads][npm-downloads-image]][npm-url]
|
8 |
|
9 | A collection mathemtatical helper functions and constant values.
|
10 |
|
11 | ## Client-Side Usage
|
12 |
|
13 | ```html
|
14 | <script src="extended-math.js"></script>
|
15 |
|
16 | <script type="text/javascript">
|
17 | extendedMath.clamp(5, 0, 2); // => 2
|
18 | </script>
|
19 | ```
|
20 |
|
21 | ## Server-Side Usage
|
22 |
|
23 | ```javascript
|
24 | const extendedMath = require("extended-math");
|
25 |
|
26 | extendedMath.clamp(5, 0, 2); // => 2
|
27 | ```
|
28 |
|
29 | ## Installation
|
30 |
|
31 | To install this module:
|
32 | ```bash
|
33 | npm install extended-math
|
34 | ```
|
35 |
|
36 | ## Building
|
37 |
|
38 | To build the distribution files for this module:
|
39 | ```bash
|
40 | npm run build
|
41 | ```
|
42 | or
|
43 | ```bash
|
44 | gulp build
|
45 | ```
|
46 |
|
47 | [npm-url]: https://www.npmjs.com/package/extended-math
|
48 | [npm-version-image]: https://img.shields.io/npm/v/extended-math.svg
|
49 | [npm-downloads-image]: http://img.shields.io/npm/dm/extended-math.svg
|
50 |
|
51 | [build-status-url]: https://travis-ci.org/nitro404/extended-math
|
52 | [build-status-image]: https://travis-ci.org/nitro404/extended-math.svg?branch=master
|
53 |
|
54 | [coverage-url]: https://coveralls.io/github/nitro404/extended-math?branch=master
|
55 | [coverage-image]: https://coveralls.io/repos/github/nitro404/extended-math/badge.svg?branch=master
|
56 |
|
57 | [vulnerabilities-url]: https://snyk.io/test/github/nitro404/extended-math?targetFile=package.json
|
58 | [vulnerabilities-image]: https://snyk.io/test/github/nitro404/extended-math/badge.svg?targetFile=package.json
|