fix: update main readme

d0whc3r · Jul 19, 2019 · 13e08d6 · 13e08d6
1 parent 6b056e9
commit 13e08d6
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,53 @@
-# YavNotifier
+# :flashlight: YavNotifier
+
 Yet another npm version notifier
 
-# Install
+# :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
-$ npm i -D @d0whc3r/yavnotifier
+yarn add -D @d0whc3r/yavnotifier
 ```
 
-# Usage
+# :notebook: Documentation and Usage
 
 ```js
 import * as yav from '@d0whc3r/yavnotifier';
+
+(async () => {
+  await yav.notify('ava', '0.0.1');
+})();
 ```
 
 [See documentation](./code/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/README.md b/code/README.md
@@ -6,7 +6,7 @@ Yet another npm version notifier
 
 <!-- [![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)
-[![codecov](https://codecov.io/gh/d0whc3r/yavnotifier/branch/master/graph/badge.svg)](https://codecov.io/gh/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)
@@ -30,6 +30,10 @@ yarn add -D @d0whc3r/yavnotifier
 
 ```js
 import * as yav from '@d0whc3r/yavnotifier';
+
+(async () => {
+  await yav.notify('ava', '0.0.1');
+})();
 ```
 
 [See documentation](./docs)

diff --git a/code/package.json b/code/package.json
@@ -8,7 +8,7 @@
     "url": "https://github.com/d0whc3r"
   },
   "repository": "https://github.com/d0whc3r/yavnotifier",
-  "homepage": "https://d0whc3r.github.io/yavnotifier",
+  "homepage": "https://github.com/d0whc3r/yavnotifier",
   "keywords": [
     "notifier",
     "registry",

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "license": "private",
+  "license": "MIT",
   "scripts": {
     "postinstall": "lerna bootstrap",
     "dev": "yarn yav:dev",