Skip to content

Commit

Permalink
WIP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nitro404 committed Mar 29, 2020
1 parent 82d8fc4 commit 35b24f6
Show file tree
Hide file tree
Showing 43 changed files with 26,029 additions and 583 deletions.
1 change: 0 additions & 1 deletion .npmignore
Expand Up @@ -11,5 +11,4 @@ package-lock.json
yarn.lock
gulpfile.js
LICENSE
README.md
CHANGELOG.md
26 changes: 20 additions & 6 deletions README.md
Expand Up @@ -10,9 +10,13 @@
[![Contributors][contributors-image]][contributors-url]
[![Pull Requests Welcome][pull-requests-image]][pull-requests-url]

A collection of useful helper functions.
A collection of useful JavaScript helper functions.

## Client-Side Usage
## Documentation

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

## Web Usage

```html
<script src="extra-utilities.js"></script>
Expand All @@ -22,12 +26,12 @@ A collection of useful helper functions.
</script>
```

## Server-Side Usage
## Node.js Usage

```javascript
const utilities = require("extra-utilities");

utilities.isBoolean(false); // => true
utilities.isValidNumber(NaN); // => false
```

## Installation
Expand All @@ -43,11 +47,21 @@ 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
npm run test
```

## Generating Documentation
```bash
gulp build
npm run docs
```

[documentation-url]: https://nitro404.github.io/extra-utilities/module-utilities.html

[npm-url]: https://www.npmjs.com/package/extra-utilities
[npm-version-image]: https://img.shields.io/npm/v/extra-utilities.svg
[npm-downloads-image]: http://img.shields.io/npm/dm/extra-utilities.svg
Expand Down

0 comments on commit 35b24f6

Please sign in to comment.