update output example

Author: adamdbradley

README.md

@@ -19,7 +19,7 @@ npm i @capacitor/docgen --save-dev
 # My Capacitor Plugin 🔌
 
 The readme file can be formatted however you'd like. Just insert 
-the  HTML placeholder comments where the Index of the API
+the HTML placeholder comments where the index of the API
 methods, and the API docs should go.
 
 Below is an index of all the methods available.
@@ -38,11 +38,14 @@ HTML placeholder comments with the updated generated docs.
 
 ## Commit Your Readme 🚀
 
-The benefit is that this readme file also acts as the landing page 
-for Github and NPM, and the anchors within the docs can also be 
-linked to and shared.
+The benefit of this readme file is that is also acts as the landing 
+page for the Github repo and NPM package, and the anchors within the 
+docs can also be linked to and shared.
 ```
 
+- [Example Readme Output](https://github.com/ionic-team/capacitor-docgen/blob/master/src/test/README.md)
+- [Example JSON Output](https://github.com/ionic-team/capacitor-docgen/blob/master/src/test/docs.json)
+
 
 ## CLI
 

package.json

@@ -21,7 +21,7 @@
     "release": "npm run build && np --no-2fa",
     "test": "jest",
     "test.watch": "jest --watchAll",
-    "test.output": "node bin/docgen --project src/test/fixtures/tsconfig.json --api HapticsPlugin --output-readme src/test/fixtures/README.md --output-json src/test/fixtures/docs.json"
+    "test.output": "node bin/docgen --project src/test/fixtures/tsconfig.json --api HapticsPlugin --output-readme src/test/README.md --output-json src/test/docs.json"
   },
   "license": "MIT",
   "files": [

src/test/fixtures/README.md src/test/README.md

@@ -1,7 +1,10 @@
+# My Capacitor Plugin 🔌
 
-# Haptics
+The readme file can be formatted however you'd like. Just insert 
+the HTML placeholder comments where the index of the API
+methods, and the API docs should go.
 
-The Haptics API provides physical feedback to the user through touch or vibration.
+Below is an index of all the methods available.
 
 <!--DOCGEN_INDEX_START-->
 * [impact()](#impact)
@@ -12,56 +15,11 @@ The Haptics API provides physical feedback to the user through touch or vibratio
 * [Enums](#enums)
 <!--DOCGEN_INDEX_END-->
 
-## Android Notes
+## Custom Content
 
-To use vibration, you must add this permission to your `AndroidManifest.xml` file:
-
-```xml
-<uses-permission android:name="android.permission.VIBRATE" />
-```
-
-## Example
-
-```typescript
-import {
-  Plugins,
-  HapticsImpactStyle
-} from '@capacitor/core';
-
-const { Haptics } = Plugins;
-
-export class HapticsExample {
-  hapticsImpact(style = HapticsImpactStyle.Heavy) {
-    Haptics.impact({
-      style: style
-    });
-  }
-
-  hapticsImpactMedium(style) {
-    this.hapticsImpact(HapticsImpactStyle.Medium);
-  }
-
-  hapticsImpactLight(style) {
-    this.hapticsImpact(HapticsImpactStyle.Light);
-  }
-
-  hapticsVibrate() {
-    Haptics.vibrate();
-  }
-
-  hapticsSelectionStart() {
-    Haptics.selectionStart();
-  }
-
-  hapticsSelectionChanged() {
-    Haptics.selectionChanged();
-  }
-
-  hapticsSelectionEnd() {
-    Haptics.selectionEnd();
-  }
-}
-```
+Manage your readme content however you'd like, and on every docgen 
+rebuild it will leave your original content as is, but update the 
+HTML placeholder comments with the updated generated docs.
 
 <!--DOCGEN_API_START-->
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
@@ -198,3 +156,9 @@ Trigger a selection started haptic hint
 
 
 <!--DOCGEN_API_END-->
+
+## Commit Your Readme 🚀
+
+The benefit of this readme file is that is also acts as the landing 
+page for the Github repo and NPM package, and the anchors within the 
+docs can also be linked to and shared.