Merge pull request #75 from ubilabs/refactor/update-readmes

BiniCodes · web-flow · commit 303148e6ed0f · 2022-10-24T20:23:51.000+02:00
Refactor/update readmes
diff --git a/README.md b/README.md
@@ -10,13 +10,16 @@ This is a JavaScript library to easily implement a Google Maps map into your Rea
 - [Installation](#installation)
 - [Usage](#usage)
 - [GoogleMapProvider](#googlemapprovider)
+  - [Properties](#properties)
 - [Hooks](#hooks)
   - [useGoogleMap](#usegooglemap)
   - [useAutocomplete](#useautocomplete)
   - [useDirections](#usedirections)
   - [useGeocoder](#usegeocoder)
   - [usePlacesService](#useplacesservice)
   - [useDistanceMatrix](#usedistancematrix)
+  - [useMaxZoomService](#usemaxzoomservice)
+  - [useElevationService](#useelevationservice)
 - [Publish](#publish)
 
 ## Requirements
diff --git a/examples/directions/README.md b/examples/directions/README.md
@@ -1,4 +1,4 @@
-# Basic Google Maps Setup Example
+# `useDirections` Hook Setup Example
 
 This is an example setup to show the usage of the **useDirections hook with findAndRenderRoute** with the Google Maps React Hooks library.
 
diff --git a/examples/geocoding/README.md b/examples/geocoding/README.md
@@ -1,4 +1,4 @@
-# Basic Google Maps Setup Example
+# `useGeocoder` Hook Setup Example
 
 This is an example setup to show the usage of the **useGeocoder hook** with the Google Maps React Hooks library.
 
diff --git a/examples/google-map-with-markers/README.md b/examples/google-map-with-markers/README.md
@@ -1,4 +1,4 @@
-# Basic Google Maps Setup Example
+# Google Maps With Markers Setup Example
 
 This is an example setup to show a **Google Map with markers** with the Google Maps React Hooks library.
 
diff --git a/examples/places-autocomplete/README.md b/examples/places-autocomplete/README.md
@@ -1,4 +1,4 @@
-# Basic Google Maps Setup Example
+# `useAutocomplete` Hook Setup Example
 
 This is an example setup of a **Map with a Places Autocomplete Search** to show the usage of the **useAutocomplete hook** with the Google Maps React Hooks library.
 
diff --git a/examples/places/README.md b/examples/places/README.md
@@ -1,4 +1,4 @@
-# Basic Google Maps Setup Example
+# `usePlacesService` Hook Setup Example
 
 This is an example setup to show a **Google Map with place** using the usePlacesService hook with the Google Maps React Hooks library.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Basic Google Maps Setup Example`
	`1`	+# `useDirections` Hook Setup Example
`2`	`2`
`3`	`3`	`This is an example setup to show the usage of the useDirections hook with findAndRenderRoute with the Google Maps React Hooks library.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Basic Google Maps Setup Example`
	`1`	+# `useGeocoder` Hook Setup Example
`2`	`2`
`3`	`3`	`This is an example setup to show the usage of the useGeocoder hook with the Google Maps React Hooks library.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Basic Google Maps Setup Example`
	`1`	`+# Google Maps With Markers Setup Example`
`2`	`2`
`3`	`3`	`This is an example setup to show a Google Map with markers with the Google Maps React Hooks library.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Basic Google Maps Setup Example`
	`1`	+# `useAutocomplete` Hook Setup Example
`2`	`2`
`3`	`3`	`This is an example setup of a Map with a Places Autocomplete Search to show the usage of the useAutocomplete hook with the Google Maps React Hooks library.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Basic Google Maps Setup Example`
	`1`	+# `usePlacesService` Hook Setup Example
`2`	`2`
`3`	`3`	`This is an example setup to show a Google Map with place using the usePlacesService hook with the Google Maps React Hooks library.`
`4`	`4`