docs(directions): update (#445)

Ombuweb · web-flow · commit ec6d8a4f42f0 · 2023-05-11T21:09:55.000-07:00
diff --git a/packages/directions/README.md b/packages/directions/README.md
@@ -1,31 +1,36 @@
 # @nativescript/directions
 <!-- TODO: Add Preview -->
+
+A plugin that allows you to launch the Google Maps app, if it's installed on the device, with some directions. For more information, visit [Directions action](https://developers.google.com/maps/documentation/urls/get-started#directions-action).
+
+## Contents
+* [Installation](#installation)
+* [Use @nativescript/directions](#use-nativescriptdirections)
+	* [Launch Google Maps with directions](#launch-google-maps-with-directions)
+	* [Check if the Google Maps app is installed](#check-if-the-google-maps-app-is-installed)
+* [API](#api)
+	* [Directions methods](#directions-methods)
+		* [NavigateToOptions](#navigatetooptions)
+
 ## Installation
 
+To install the plugin, run the following command in the root directory of your app.
+
 ```cli
 npm install @nativescript/directions
 ```
 
-## Usage
-### Importing
-Once you have installed the plugin, import and create an instance of the `Directions` class.
-```ts
-import { Directions } from "@nativescript/directions"
-
-const directions = new Directions()
-```
+## Use @nativescript/directions
 
-### Checking for support
+### Launch Google Maps with directions
 
-To check if the device has a Maps application installed, call the `available` method.
-```ts
-directions.available().then((avail:boolean) => {
+To launch Google Maps with the desired directions, call the `navigate` method on  `Directions` instance passing it a [NavigateToOptions](#navigatetooptions) object.
 
-	console.log(avail ? 'Yes' : 'No');
-});
-```
-To open the Google (Android) or Apple (iOS) Maps app with the desired directions, call the `navigate` method.
 ```typescript
+import { Directions } from "@nativescript/directions"
+
+const directions = new Directions()
+
 directions
 	.navigate({
 		from: {
@@ -60,28 +65,32 @@ directions
 	);
 ```
 
+### Check if the Google Maps app is installed
+
+If you need to check if the Google Maps mobile application is installed on the device, call the `available` method.
+
+```ts
+const directions = new Directions()
+
+directions.available().then((avail:boolean) => {
+
+	console.log(avail ? 'Yes' : 'No');
+});
+```
+
 ## API
-### Method(s)
+### Directions methods
+
+The `Directions` class has the following two methods:
 
-| Name | Return Type | Description |
+| Method | Returns | Description |
 |------|-------------|-------------|
 | `available()` | `Promise<boolean>` | Checks if the device has the Maps application installed. |
 | `navigate(options: NavigateToOptions)`| `Promise<void>` | Opens the native Maps app with a predefined `from` and `to` address and [other](#navigatetooptions) optional settings.|
 
-### AddressOptions
-| Name| Type | Description|
-|-----|------|------------|
-| `lat` | `number` | _Optional_: The latitude. Ignored if `address`' is set.|
-| `lng` | `number` | _Optional_: The longitude. Ignored if `address`' is set. |
-| `address` | `string` | _Optional_: The address of the direction. For multiple addresses, add them to the string separating them with a comma.|
-
-### NavigateToOptionsType
-```ts
-'driving' | 'transit' | 'bicycling' | 'walking'
-```
-
 ### NavigateToOptions
-| Name| Type | Description|
+
+| Property| Type | Description|
 |-----|------|------------|
 | `from`| [AddressOptions](#addressoptions)| _Optional_: The starting point for the navigation. <br><br>If this option is not passed, the current location of the user will be used.|
 | `to` | [AddressOptions](#addressoptions) \| Array<[AddressOptions](#addressoptions)>| The destination of the navigation. If it's an array of addresses, then the last item is the destination, the others become 'waypoints'.|
@@ -91,13 +100,28 @@ directions
 | `type` | [NavigateToOptionsType](#navigatetooptionstype) | _Optional_: The mode of reaching to the destionation. |
 
 >**Note** that if there's an ocean in between `from` and `to` you won't be able to get directions, don't blame this plugin for that 😁.
-### iOSOptions
+
+#### AddressOptions
+
+| Name| Type | Description|
+|-----|------|------------|
+| `lat` | `number` | _Optional_: The latitude. Ignored if `address`' is set.|
+| `lng` | `number` | _Optional_: The longitude. Ignored if `address`' is set. |
+| `address` | `string` | _Optional_: The address of the direction. For multiple addresses, add them to the string separating them with a comma.|
+
+#### NavigateToOptionsType
+```ts
+'driving' | 'transit' | 'bicycling' | 'walking'
+```
+
+#### iOSOptions
 | Name| Type | Description|
 |-----|------|------------|
 | `preferGoogleMaps`| `boolean`| _Optional_: Indicates whether to use Google Maps(if installed) instead of the iOS Maps. You might want to use Google Maps app because it supports waypoints.|
 | `allowGoogleMapsWeb`| `boolean` | If waypoints are passed in and Google Maps is not installed, you can either open Apple Maps and the first waypoint is used as the to-address (the rest is ignored), or you can set this option to `true` to open Google Maps on web so all waypoints are shown.|
 
-### AndroidOptions
+#### AndroidOptions
+
 | Name| Type | Description|
 |-----|------|------------|
 | `newTask` | `boolean` | _Optional_: Indicates whether to start directions as new task.|
