Merge branch 'master' of github.com:d0whc3r/yavnotifier

d0whc3r · Jul 19, 2019 · 9d92560 · 9d92560
2 parents 633cf38 + f91853d
commit 9d92560
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 6 deletions.
diff --git a/code/CHANGELOG.md b/code/CHANGELOG.md
@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.4](https://github.com/d0whc3r/yavnotifier/compare/@d0whc3r/yavnotifier@1.1.3...@d0whc3r/yavnotifier@1.1.4) (2019-07-19)
+
+
+### Bug Fixes
+
+* fix coverage in codecovs ([69de371](https://github.com/d0whc3r/yavnotifier/commit/69de371))
+* sonnar issues ([6b056e9](https://github.com/d0whc3r/yavnotifier/commit/6b056e9))
+* sonnar issues ([72bb205](https://github.com/d0whc3r/yavnotifier/commit/72bb205))
+* update main readme ([13e08d6](https://github.com/d0whc3r/yavnotifier/commit/13e08d6))
+* update versions ([552e0c9](https://github.com/d0whc3r/yavnotifier/commit/552e0c9))
+
+
+
+
+
 ## [1.1.3](https://github.com/d0whc3r/yavnotifier/compare/@d0whc3r/yavnotifier@1.1.2...@d0whc3r/yavnotifier@1.1.3) (2019-07-19)
 
 

diff --git a/code/docs/README.md b/code/docs/README.md
@@ -2,6 +2,58 @@
 
 [Globals](globals.md) /
 
-# yavnotifier
+# :flashlight: YavNotifier
 
-Yet another npm version notifier
+Yet another npm version notifier
+
+# :eyes: Project status
+
+<!-- [![Netlify Status](https://api.netlify.com/api/v1/badges/f40b0f7c-b2a8-4cd5-ba62-fe2da3dfa48c/deploy-status)](https://app.netlify.com/sites/yavnotifier/deploys) -->
+[![pipeline status](https://gitlab.com/d0whc3r/yavnotifier/badges/master/pipeline.svg)](https://github.com/d0whc3r/yavnotifier)
+[![Coverage Status](https://coveralls.io/repos/github/d0whc3r/yavnotifier/badge.svg?branch=master)](https://coveralls.io/github/d0whc3r/yavnotifier?branch=master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e71315d50acb42b29d6158d3e9305f4d)](https://www.codacy.com/app/d0whc3r/yavnotifier?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=d0whc3r/yavnotifier&amp;utm_campaign=Badge_Grade)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=d0whc3r_yavnotifier&metric=alert_status)](https://sonarcloud.io/dashboard?id=d0whc3r_yavnotifier)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=d0whc3r_yavnotifier&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=d0whc3r_yavnotifier)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=d0whc3r_yavnotifier&metric=security_rating)](https://sonarcloud.io/dashboard?id=d0whc3r_yavnotifier)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=d0whc3r_yavnotifier&metric=bugs)](https://sonarcloud.io/dashboard?id=d0whc3r_yavnotifier)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=d0whc3r_yavnotifier&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=d0whc3r_yavnotifier)
+![dependencies](https://img.shields.io/david/d0whc3r/yavnotifier.svg)
+[![npm version](https://img.shields.io/npm/v/@d0whc3r%2Fyavnotifier.svg)](https://www.npmjs.com/package/@d0whc3r/yavnotifier)
+
+# :rocket: Install
+
+```bash
+npm i -D @d0whc3r/yavnotifier
+```
+
+```bash
+yarn add -D @d0whc3r/yavnotifier
+```
+
+# :notebook: Documentation and Usage
+
+```js
+import * as yav from '@d0whc3r/yavnotifier';
+
+(async () => {
+  await yav.notify('ava', '0.0.1');
+})();
+```
+
+![sample image](./sample.png)
+
+[See documentation](./docs)
+
+# :bar_chart: Project tests
+
+```bash
+yarn test
+```
+
+# :copyright: License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+# :bookmark: Keywords
+
+`notifier`, `registry`, `version`, `checker`, `private`
diff --git a/code/docs/globals.md b/code/docs/globals.md
@@ -18,7 +18,7 @@
 
 ▸ **isUpdated**(`name`: string, `version`: string): *`Promise<boolean>`*
 
-*Defined in [index.ts:22](https://github.com/d0whc3r/yavnotifier/blob/2fef350/code/src/index.ts#L22)*
+*Defined in [index.ts:21](https://github.com/d0whc3r/yavnotifier/blob/c3566b7/code/src/index.ts#L21)*
 
 Check if a package and version is the latest
 
@@ -39,7 +39,7 @@ ___
 
 ▸ **latest**(`name`: string): *`Promise<string>`*
 
-*Defined in [index.ts:12](https://github.com/d0whc3r/yavnotifier/blob/2fef350/code/src/index.ts#L12)*
+*Defined in [index.ts:11](https://github.com/d0whc3r/yavnotifier/blob/c3566b7/code/src/index.ts#L11)*
 
 Get the latest version of a package
 
@@ -59,7 +59,7 @@ ___
 
 ▸ **notify**(`name`: string, `version`: string, `message`: string): *`Promise<void>`*
 
-*Defined in [index.ts:34](https://github.com/d0whc3r/yavnotifier/blob/2fef350/code/src/index.ts#L34)*
+*Defined in [index.ts:33](https://github.com/d0whc3r/yavnotifier/blob/c3566b7/code/src/index.ts#L33)*
 
 Show a notification if there is a newest version for package
 

diff --git a/code/package.json b/code/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@d0whc3r/yavnotifier",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "license": "MIT",
   "author": {
     "email": "d0whc3r@gmail.com",