diff --git a/README.md b/README.md index c18c929..edbebc5 100755 --- a/README.md +++ b/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) diff --git a/docs/data/hsOsaes6.json b/docs/data/hsOsaes6.json index 2b53e12..81dc441 100644 --- a/docs/data/hsOsaes6.json +++ b/docs/data/hsOsaes6.json @@ -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": [ { diff --git a/docs/data/src/hsOsaes6/overview.html b/docs/data/src/hsOsaes6/overview.html index 760c611..0bbb810 100644 --- a/docs/data/src/hsOsaes6/overview.html +++ b/docs/data/src/hsOsaes6/overview.html @@ -26,7 +26,7 @@

src/overview.ts

   3 * 

   4 * Helpful Scripts ES6 interface to various OSX functions using the OSA Architecture. 

   5 * [`[Github page]`](https://github.com/HelpfulScripts/hsOsaES6)

-

   6 * [`[Coverage Info]`](./data/src/hsOsaES6/coverage/)

+

   6 * [`[Coverage Info]`](./data/src/hsOsaes6/coverage/)

   7 * ___

   8 * 

   9 * Provides a means for calling JavaScript functions in Apple's OSA environment.