Skip to content

Commit

Permalink
Change JSDoc template to docdash, rename doc to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gamtiq committed May 6, 2020
1 parent ef6ad3e commit 7c08510
Show file tree
Hide file tree
Showing 104 changed files with 9,670 additions and 149,971 deletions.
5 changes: 1 addition & 4 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,8 @@ module.exports = function(grunt) {

jsdoc: {
dist: {
src: ["chronoman.js", "README.md"],
options: {
destination: "doc",
template: "node_modules/ink-docstrap/template",
configure: "jsdoc-conf.json"
configure: "jsdoc-conf.js"
}
}
},
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# chronoman

[![NPM version](https://badge.fury.io/js/chronoman.png)](http://badge.fury.io/js/chronoman)
[![Build Status](https://secure.travis-ci.org/gamtiq/chronoman.png?branch=master)](http://travis-ci.org/gamtiq/chronoman)
[![Built with Grunt](https://gruntjs.com/cdn/builtwith.png)](http://gruntjs.com/)

Utility class to simplify use of timers created by `setTimeout`.

### Features
Expand Down Expand Up @@ -29,17 +33,13 @@ var timer = new Timer({
timer.stop();
```

[![NPM version](https://badge.fury.io/js/chronoman.png)](http://badge.fury.io/js/chronoman)
[![Build Status](https://secure.travis-ci.org/gamtiq/chronoman.png?branch=master)](http://travis-ci.org/gamtiq/chronoman)
[![Built with Grunt](https://gruntjs.com/cdn/builtwith.png)](http://gruntjs.com/)

## Installation

### Node

npm install chronoman

### [Bower](http://bower.io)
### [Bower](https://bower.io)

bower install chronoman

Expand Down Expand Up @@ -98,7 +98,7 @@ var tmrOne = new Timer({
});

var tmrTwo = new Timer();
tmrTwo.setPeriod([2000, , {start: 1000, end: 1500}])
tmrTwo.setPeriod([2000, {start: 1000, end: 1500}])
.setRepeatQty(9)
.setPassToAction(true)
.setAction({
Expand Down Expand Up @@ -127,7 +127,7 @@ See `test/chronoman.js` for additional examples.

## API

See `doc` folder.
See [`docs`](https://gamtiq.github.io/chronoman/).

## Related projects

Expand Down
Loading

0 comments on commit 7c08510

Please sign in to comment.