chore(haptics): README update (#452)

Ombuweb · web-flow · commit 16237feda042 · 2023-05-11T21:12:20.000-07:00
diff --git a/packages/haptics/README.md b/packages/haptics/README.md
@@ -1,13 +1,17 @@
 # @nativescript/haptics
 
+A plugin that allows you to add haptics to your app.
+
 > Playing haptics can engage people's sense of touch and bring their familiarity with the physical world into your app or game.
 ~ Developer docs
 
 
 Thanks to [Eddy Verbruggen](EddyVerbruggen) for providing [nativescript-taptic-engine](https://github.com/EddyVerbruggen/nativescript-taptic-engine) as this continues its evolution by streamlining the API and adding Android support, inspired by [react-native-haptic-feedback](https://github.com/junina-de/react-native-haptic-feedback).
 
-## Table of Contents
+## Contents
+
   * [Installation](#installation)
+  * [Use @nativescript/haptics](#use-nativescripthaptics)
   * [API](#api)
     * [isSupported()](#issupported)
     * [is6SAnd6SPlusSupported()](#is6sand6splussupported)
@@ -26,13 +30,19 @@ Thanks to [Eddy Verbruggen](EddyVerbruggen) for providing [nativescript-taptic-e
 npm install @nativescript/haptics
 ```
 
+## Use @nativescript/haptics
+
+Find an example of `@nativescript/haptics` usage [here](https://stackblitz.com/edit/nativescript-stackblitz-templates-jlvtwm?file=app/main-view-model.ts) on StackBlitz. 
+
 ## API
 
+The plugin provides the API below.
+
 ### isSupported()
 ```ts
 isHapticsSupported: boolean = Haptics.isSupported()
 ```
-Checks if Haptics is supported.
+Checks if haptics is supported on the device.
 
 ---
 ### is6SAnd6SPlusSupported()
@@ -84,7 +94,7 @@ There are 3 impact types:
 
 ### HapticsFallback
 
-To use the haptics fallbacks, first check if there is support:
+To use the haptics fallbacks, check if there is support:
 
 ```ts
 if (!Haptics.isSupported() && Haptics.is6SAnd6SPlusSupported()) {
@@ -110,15 +120,15 @@ import { HapticsFallback } from "@nativescript/haptics";
 
 HapticsFallback.strongBoom();
 ```
-This triggers the 'Pop' effect of 'Peek & Pop', which is a bit more profound than the 'Peek' effect.
+This triggers the `Pop` effect of `Peek & Pop`, which is a bit more profound than the `Peek` effect.
 
 ### burst()
 ```ts
 import { HapticsFallback } from "@nativescript/haptics";
 
 HapticsFallback.burst();
 ```
-This triggers the 'Nope' effect you get when force-touching a home icon that doesn't have any action. It's a short burst of 3-ish 'weak booms'.
+This triggers the `Nope` effect you get when force-touching a home icon that doesn't have any action. It's a short burst of 3-ish 'weak booms'.
 
 ## Changelog
 * 3.0.0  Moved to @nativescript/haptics and added Android support. Adjusted naming conventions.
