Skip to content

Commit

Permalink
add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Vandenberg committed May 23, 2020
1 parent 845368c commit ad52356
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@

# js-utils
[![Build Status](https://travis-ci.com/publicstrategies/js-utils.svg?branch=master)](https://travis-ci.com/publicstrategies/js-utils)
[![Coverage Status](https://coveralls.io/repos/github/publicstrategies/js-utils/badge.svg?branch=master)](https://coveralls.io/github/publicstrategies/js-utils?branch=master)

<a name="sumOf"></a>

## sumOf(array, ...keys) ⇒ <code>number</code>
Expand All @@ -9,8 +14,8 @@ sumOf(data, &quot;nested&quot;, &quot;value&quot;); // 46
</code></pre>


| Param | Type | Description |
| --- | --- | --- |
| array | <code>Array.&lt;any&gt;</code> | <p>The array of objects with a shared shallow or nested property.</p> |
| ...keys | <code>string</code> | <p>The property accessor(s) for the objects in the array.</p> |
| Param | Type | Description |
| ------- | ------------------------------ | --------------------------------------------------------------------- |
| array | <code>Array.&lt;any&gt;</code> | <p>The array of objects with a shared shallow or nested property.</p> |
| ...keys | <code>string</code> | <p>The property accessor(s) for the objects in the array.</p> |

15 changes: 13 additions & 2 deletions scripts/docs.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
#!/bin/bash
# [![Build Status](https://travis-ci.com/publicstrategies/js-utils.svg?branch=master)](https://travis-ci.com/publicstrategies/js-utils)
jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json | sed '/\\*\\*Kind\\*\\*/d' > README.md

jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json | sed '/\\*\\*Kind\\*\\*/d' > README.md

BADGE_TRAVIS="[![Build Status](https://travis-ci.com/publicstrategies/js-utils.svg?branch=master)](https://travis-ci.com/publicstrategies/js-utils)"
BADGE_COVERALLS="[![Coverage Status](https://coveralls.io/repos/github/publicstrategies/js-utils/badge.svg?branch=master)](https://coveralls.io/github/publicstrategies/js-utils?branch=master)"

USAGE=$"
# js-utils
$BADGE_TRAVIS
$BADGE_COVERALLS
"

echo "$USAGE" | cat - README.md > temp && mv temp README.md

0 comments on commit ad52356

Please sign in to comment.