readme/doc

Author: farfromrefug

README.md

@@ -66,6 +66,7 @@
 [](#installation)
 
 ## Installation
+
 Run the following command from the root of your project:
 
 `ns plugin add @nativescript-community/gesturehandler`
@@ -79,16 +80,18 @@ Run the following command from the root of your project:
 ## API
 
 We need to do some wiring when your app starts, so open `app.ts` and add this before creating any View/App/Frame:
+
 ##### TypeScript
+
 ```ts
-import { install } from "@nativescript-community/gesturehandler";
+import { install } from '@nativescript-community/gesturehandler';
 install();
 ```
 
 You create a gesture handler using something like this:
-```typescript 
-import { GestureHandlerTouchEvent, GestureHandlerStateEvent, GestureStateEventData, GestureTouchEventData, HandlerType } from '@nativescript-community/gesturehandler';
 
+```typescript
+import { GestureHandlerTouchEvent, GestureHandlerStateEvent, GestureStateEventData, GestureTouchEventData, HandlerType, Manager } from '@nativescript-community/gesturehandler';
 
 function onGestureTouch(args: GestureTouchEventData) {
     const { state, extraData, view } = args.data;
@@ -100,17 +103,17 @@ function onGestureState(args: GestureStateEventData) {
     console.log('onGestureState', state, prevState, view, extraData);
 }
 const manager = Manager.getInstance();
-const gestureHandler = = manager.createGestureHandler(HandlerType.PAN, 10, {
+const gestureHandler = manager.createGestureHandler(HandlerType.PAN, 10, {
     shouldCancelWhenOutside: false
 });
 gestureHandler.on(GestureHandlerTouchEvent, onGestureTouch, this);
 gestureHandler.on(GestureHandlerStateEvent, onGestureState, this);
 gestureHandler.attachToView(view);
 ```
 
-Right now you must not forget to store the ```gestureHandler``` somewhere or the gesture won't work on iOS (native object being released). This will be fixed in future versions.
+Right now you must not forget to store the `gestureHandler` somewhere or the gesture won't work on iOS (native object being released). This will be fixed in future versions.
 
-Now about the API. All the gestures for the react counterpart exist with the same options and the same event ```extraData```.
+Now about the API. All the gestures for the react counterpart exist with the same options and the same event `extraData`.
 
 
 [](#gesturerootview)
@@ -132,7 +135,7 @@ In case you don't (drawer root view, modals, ...) then you can wrap your views i
 
 ## Overriding Nativescript gestures
 
-This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes `tap` and `longpress`
+This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes `tap` and `longpress`.
 
 To do that 
 
@@ -145,9 +148,7 @@ To do that
 ## Credits
 
 This is a port of [react-native-gesturehandler](https://kmagiera.github.io/react-native-gesture-handler/).
-The source is based on the source code by [Krzysztof Magiera](https://github.com/kmagiera). Dont hesitate to go and thank him for his work!
-
-
+The source is based on the source code by [Krzysztof Magiera](https://github.com/kmagiera). Don't hesitate to go and thank him for his work!
 
 ### Examples:
 
@@ -262,6 +263,7 @@ One easy solution is t modify `~/.gitconfig` and add
 
 If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
 
+
 [](#demos-and-development)
 
 ## Demos and Development