Skip to content

Commit

Permalink
added Docs badge
Browse files Browse the repository at this point in the history
  • Loading branch information
HelpfulScripts committed May 26, 2019
1 parent 73faeb5 commit f8f04f3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
@@ -1,9 +1,10 @@
hsOsaES6
========
[![GitHub version](https://badge.fury.io/gh/HelpfulScripts%2FhsOsaES6@2x.png)](https://badge.fury.io/gh/HelpfulScripts%2FhsOsaES6)
[![npm version](https://badge.fury.io/js/hsosaes6.svg)](https://badge.fury.io/js/hsosaes6)
[https://img.shields.io/badge/hsDocs--blue.svg](https://helpfulscripts.github.io/hsOsaES6/#!/api/hsOsaes6/0)
[![Build Status](https://travis-ci.org/HelpfulScripts/hsOsaES6.svg?branch=master)](https://travis-ci.org/HelpfulScripts/hsOsaES6)
[![Coverage Status](https://coveralls.io/repos/github/HelpfulScripts/hsOsaES6/badge.svg?branch=master)](https://coveralls.io/github/HelpfulScripts/hsOsaES6?branch=master)
[![Built with Grunt](https://cdn.gruntjs.com/builtwith.svg)](https://gruntjs.com/)
[![NPM License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://www.npmjs.com/package/hsosaes6)
[![Known Vulnerabilities](https://snyk.io/test/github/HelpfulScripts/hsOsaEs6/badge.svg?targetFile=package.json)](https://snyk.io/test/github/HelpfulScripts/hsOsaEs6?targetFile=package.json)

Expand Down
2 changes: 1 addition & 1 deletion docs/data/hsOsaes6.json
Expand Up @@ -4198,7 +4198,7 @@
"originalName": "/Users/sth1pal/Documents/Development/JavaScript/nodejs/ts6/dev/hsLibs/node/hsOsaES6/src/overview.ts",
"comment": {
"shortText": "# hsOsaES6",
"text": "Helpful Scripts ES6 interface to various OSX functions using the OSA Architecture.\n[`[Github page]`](https://github.com/HelpfulScripts/hsOsaES6)\n[`[Coverage Info]`](./data/src/hsOsaES6/coverage/)\n___\n\nProvides a means for calling JavaScript functions in Apple's OSA environment.\nAt the core, the function {@link osaLib.osaJS osaJS} is a port from [brandonhorst's node-osa](https://github.com/brandonhorst/node-osa) module,\nin ES6 using Typescript and promises.\n\n`osaJs` is internally called by a number of OSX convenience functions exported as\n{@link Commands.osaCommands osaCommands}.\nCurrently available functions are:\n-   {@link Commands.osaCommands.facetime facetime} starts a facetime call with a buddy\n-   {@link Commands.osaCommands.getEmail getEmail} gets recent emails from `Mail`\n-   {@link Commands.osaCommands.sendEmail sendEmail} sends an email using `Mail`\n-   {@link Commands.osaCommands.launch launch} launches an application (such as `Mail`)\n-   {@link Commands.osaCommands.isRunning isRunning} checks if an application is running\n-   {@link Commands.osaCommands.quit quit} quits a running application\n-   {@link Commands.osaCommands.launchScript launchScript} launches another OSA script\n-   {@link Commands.osaCommands.restart restart} restarts the Mac\n-   {@link Commands.osaCommands.sendMessage sendMessage} sends a text message to a buddy via `Messages`\n-   {@link Commands.osaCommands.setVolume setVolume} sets the speaker volume\n-   {@link Commands.osaCommands.say say} speaks a text string using the built-in voice synthesis\n-   {@link Commands.osaCommands.setBrightness setBrightness} sets the screen brightness\n\n"
"text": "Helpful Scripts ES6 interface to various OSX functions using the OSA Architecture.\n[`[Github page]`](https://github.com/HelpfulScripts/hsOsaES6)\n[`[Coverage Info]`](./data/src/hsOsaes6/coverage/)\n___\n\nProvides a means for calling JavaScript functions in Apple's OSA environment.\nAt the core, the function {@link osaLib.osaJS osaJS} is a port from [brandonhorst's node-osa](https://github.com/brandonhorst/node-osa) module,\nin ES6 using Typescript and promises.\n\n`osaJs` is internally called by a number of OSX convenience functions exported as\n{@link Commands.osaCommands osaCommands}.\nCurrently available functions are:\n-   {@link Commands.osaCommands.facetime facetime} starts a facetime call with a buddy\n-   {@link Commands.osaCommands.getEmail getEmail} gets recent emails from `Mail`\n-   {@link Commands.osaCommands.sendEmail sendEmail} sends an email using `Mail`\n-   {@link Commands.osaCommands.launch launch} launches an application (such as `Mail`)\n-   {@link Commands.osaCommands.isRunning isRunning} checks if an application is running\n-   {@link Commands.osaCommands.quit quit} quits a running application\n-   {@link Commands.osaCommands.launchScript launchScript} launches another OSA script\n-   {@link Commands.osaCommands.restart restart} restarts the Mac\n-   {@link Commands.osaCommands.sendMessage sendMessage} sends a text message to a buddy via `Messages`\n-   {@link Commands.osaCommands.setVolume setVolume} sets the speaker volume\n-   {@link Commands.osaCommands.say say} speaks a text string using the built-in voice synthesis\n-   {@link Commands.osaCommands.setBrightness setBrightness} sets the screen brightness\n\n"
},
"sources": [
{
Expand Down
2 changes: 1 addition & 1 deletion docs/data/src/hsOsaes6/overview.html
Expand Up @@ -26,7 +26,7 @@ <h1>src/overview.ts</h1>
<p id=3 class="line"><span>&nbsp;&nbsp;&nbsp;3</span><comment>&nbsp;*&nbsp;</comment></p>
<p id=4 class="line"><span>&nbsp;&nbsp;&nbsp;4</span><comment>&nbsp;*&nbsp;Helpful&nbsp;Scripts&nbsp;ES6&nbsp;interface&nbsp;to&nbsp;various&nbsp;OSX&nbsp;functions&nbsp;using&nbsp;the&nbsp;OSA&nbsp;Architecture.&nbsp;</comment></p>
<p id=5 class="line"><span>&nbsp;&nbsp;&nbsp;5</span><comment>&nbsp;*&nbsp;[`[Github&nbsp;page]`](https:<comment>//github.com/HelpfulScripts/hsOsaES6)</comment></comment></p>
<p id=6 class="line"><span>&nbsp;&nbsp;&nbsp;6</span><comment><comment></comment>&nbsp;*&nbsp;[`[Coverage&nbsp;Info]`](./data/src/hsOsaES6/coverage/)</comment></p>
<p id=6 class="line"><span>&nbsp;&nbsp;&nbsp;6</span><comment><comment></comment>&nbsp;*&nbsp;[`[Coverage&nbsp;Info]`](./data/src/hsOsaes6/coverage/)</comment></p>
<p id=7 class="line"><span>&nbsp;&nbsp;&nbsp;7</span><comment>&nbsp;*&nbsp;___</comment></p>
<p id=8 class="line"><span>&nbsp;&nbsp;&nbsp;8</span><comment>&nbsp;*&nbsp;</comment></p>
<p id=9 class="line"><span>&nbsp;&nbsp;&nbsp;9</span><comment>&nbsp;*&nbsp;Provides&nbsp;a&nbsp;means&nbsp;for&nbsp;calling&nbsp;JavaScript&nbsp;functions&nbsp;in&nbsp;Apple<quote>'s&nbsp;OSA&nbsp;environment.&nbsp;</comment></p>
Expand Down

0 comments on commit f8f04f3

Please sign in to comment.