Skip to content

Commit

Permalink
WIP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nitro404 committed Mar 22, 2020
1 parent db3b281 commit 3d81be1
Show file tree
Hide file tree
Showing 41 changed files with 6,286 additions and 146 deletions.
23 changes: 19 additions & 4 deletions README.md
Expand Up @@ -10,15 +10,19 @@
[![Contributors][contributors-image]][contributors-url]
[![Pull Requests Welcome][pull-requests-image]][pull-requests-url]

A collection mathemtatical helper functions and constant values.
A collection of JavaScript mathemtatical helper functions and constant values.

## Documentation

Work-in-progress documentation is available [here][documentation-url].

## Client-Side Usage

```html
<script src="extended-math.js"></script>

<script type="text/javascript">
extendedMath.clamp(5, 0, 2); // => 2
extendedMath.clamp(5, 0, 2); // => 2
</script>
```

Expand All @@ -43,11 +47,22 @@ To build the distribution files for this module:
```bash
npm run build
```
or

## Running Unit Tests

To run the unit test suite for this module:
```bash
gulp build
npm run test
```

## Generating Documentation

```bash
npm run docs
```

[documentation-url]: https://nitro404.github.io/extended-math/module-extendedMath.html

[npm-url]: https://www.npmjs.com/package/extended-math
[npm-version-image]: https://img.shields.io/npm/v/extended-math.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/extended-math.svg
Expand Down
68 changes: 64 additions & 4 deletions dist/extended-math.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/extended-math.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions dist/extended-math.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file added docs/.nojekyll
Empty file.

0 comments on commit 3d81be1

Please sign in to comment.