Update docs

farengeyt451 · Apr 29, 2022 · e2f5229 · e2f5229
1 parent 84c8aea
commit e2f5229
Show file tree

Hide file tree

Showing 4 changed files with 848 additions and 88 deletions.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -1,13 +1,13 @@
 ## Migration Guide
 
-- From version 2.x.x to version 3.x.x
+### - From version 2.x.x to version 3.x.x
 
-### Grouped tooltips
+#### Grouped tooltips
 
 1. In order to pass common props use `[groupedProps]` instead of `[tippyProps]`
 2. For each tooltip within `ngx-tippy-group` component you should pass `data-tippy-grouped` attribute instead of `data-tippy`
 
-### Singleton
+#### Singleton
 
 What's new:
 
@@ -35,3 +35,9 @@ Migration steps:
 
 1. Instead `setTriggerTarget` method from service, set `triggerTarget` via properties
 2. Pass `data-tippy-singleton` attribute for each child tooltip within `ngx-tippy-singleton` component
+
+### - From version 4.x.x to version 5.x.x
+
+Migration steps:
+
+1. Rename interface `NgxHideAllOptions` to `NgxTippyHideAllOptions`
diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
 <div align="center">
-  <img src="https://raw.githubusercontent.com/farengeyt451/ngx-tippy-wrapper/master/images/logo.svg" alt="library logo" height="180">
+  <img
+    src="https://raw.githubusercontent.com/farengeyt451/ngx-tippy-wrapper/master/images/logo.svg"
+    alt="library logo"
+    height="180"
+  >
 </div>
 
 <div align="center">
-  <h1>Angular wrapper for <a href="https://atomiks.github.io/tippyjs/">Tippy.js</a></h1>
+  <h1>Angular wrapper for tippy.js</h1>
 
-[![GitHub branch checks state](https://img.shields.io/github/checks-status/farengeyt451/ngx-tippy-wrapper/master?color=%23008000%09&label=unit-tests&logo=jasmine&style=flat-square)](https://github.com/farengeyt451/ngx-tippy-wrapper/actions)
-[![GitHub branch checks state](https://img.shields.io/github/checks-status/farengeyt451/ngx-tippy-wrapper/master?color=%23008000%09&label=build&logo=github&style=flat-square)](https://github.com/farengeyt451/ngx-tippy-wrapper/actions)
-[![Codecov branch](https://img.shields.io/codecov/c/gh/farengeyt451/ngx-tippy-wrapper/branch/master?color=%23008000%09&logo=codecov&style=flat-square&token=DXO20XP4F6)](https://app.codecov.io/gh/farengeyt451/ngx-tippy-wrapper/)
-[![npm](https://img.shields.io/npm/dw/ngx-tippy-wrapper?color=%230879b9&logo=npm&style=flat-square)](https://www.npmjs.com/package/ngx-tippy-wrapper)
-[![GitHub](https://img.shields.io/github/license/farengeyt451/ngx-tippy-wrapper?color=%230879b9&logo=MicroStrategy&style=flat-square)](https://github.com/farengeyt451/ngx-tippy-wrapper/blob/master/LICENSE)
-[![npm bundle size](https://img.shields.io/bundlephobia/min/ngx-tippy-wrapper?color=%230879b9&logo=Webpack&style=flat-square)](https://bundlephobia.com/package/ngx-tippy-wrapper)
-[![Tippy.js](https://img.shields.io/badge/tippy.js-v.6.3.7-%230879b9?style=flat-square&logo=Linux%20Foundation)](https://github.com/atomiks/tippyjs/releases)
+[![GitHub branch checks state](https://img.shields.io/github/checks-status/farengeyt451/ngx-tippy-wrapper/master?style=for-the-badge)](https://github.com/farengeyt451/ngx-tippy-wrapper/actions)
+[![Codecov branch](https://img.shields.io/codecov/c/github/farengeyt451/ngx-tippy-wrapper/master?style=for-the-badge)](https://app.codecov.io/gh/farengeyt451/ngx-tippy-wrapper/)
+[![GitHub](https://img.shields.io/github/license/farengeyt451/ngx-tippy-wrapper?color=%235599ff&style=for-the-badge)](https://github.com/farengeyt451/ngx-tippy-wrapper/blob/master/LICENSE)
 
 </div>
 
@@ -23,9 +23,10 @@
 
 ## Recommended versions to use
 
-- **Angular 8**: 2.x.x
-- **Angular 9, 10, 11** 3.x.x
+- **Angular 13**: 5.x.x
 - **Angular 12**: 4.x.x
+- **Angular 9, 10, 11** 3.x.x
+- **Angular 8**: 2.x.x
 
 ## Installation
 
@@ -492,11 +493,11 @@ Through service you can use all methods described [here](https://atomiks.github.
 
 **Static methods**
 
-| Method name       | Method parameter/parameters   | Method short description                                                                 |
-| ----------------- | ----------------------------- | ---------------------------------------------------------------------------------------- |
-| setDefaultProps() | `tippyProps`: NgxTippyProps   | Set the default props for each new tippy instance                                        |
-| showAll()         | -                             | Show all tippies                                                                         |
-| hideAll()         | `options?`: NgxHideAllOptions | Hide all tippies or hide all except a particular one, additional hide them with duration |
+| Method name       | Method parameter/parameters        | Method short description                                                                 |
+| ----------------- | ---------------------------------- | ---------------------------------------------------------------------------------------- |
+| setDefaultProps() | `tippyProps`: NgxTippyProps        | Set the default props for each new tippy instance                                        |
+| showAll()         | -                                  | Show all tippies                                                                         |
+| hideAll()         | `options?`: NgxTippyHideAllOptions | Hide all tippies or hide all except a particular one, additional hide them with duration |
 
 ### Subscription for tippy instances change
 
@@ -809,3 +810,5 @@ export class DemoComponent implements OnInit {
 [Documentation for v2.1.0](./docs/README-v2.1.0.md)
 
 [Documentation for v3.0.1](./docs/README-v3.0.1.md)
+
+[Documentation for v4.0.1](./docs/README-v4.0.1.md)