chore: update readme

Author: timwangdev

README.md

@@ -2,14 +2,13 @@
 
 Multi-platform Geocoding library for React Native apps.
 
-
 [![CircleCI](https://circleci.com/gh/timwangdev/react-native-geocoder-reborn/tree/master.svg?style=shield)](https://circleci.com/gh/timwangdev/react-native-geocoder-reborn/tree/master)
 [![npm](https://img.shields.io/npm/v/@timwangdev/react-native-geocoder.svg)](https://www.npmjs.com/package/@timwangdev/react-native-geocoder)
 [![Downloads](https://img.shields.io/npm/dw/@timwangdev/react-native-geocoder.svg)](https://www.npmjs.com/package/@timwangdev/react-native-geocoder)
 
-The project is originally forked from [devfd/react-native-geocoder](https://github.com/devfd/react-native-geocoder). Since 1.0 the project have been refactored and supports more features includes maximum results limit, search boundary and React hooks.
+The project is originally forked from [devfd/react-native-geocoder](https://github.com/devfd/react-native-geocoder). Since 1.0 the project have been refactored and supports more features includes web support, maximum results limit, search boundary and request headers for Google Maps API.
 
-**Please check the [Release page](https://github.com/timwangdev/react-native-geocoder-reborn/releases/tag/v1.0.0) for Version 1.0.0 Full Changelog and Migration Guide.**
+**Please check the [GitHub Release page](https://github.com/timwangdev/react-native-geocoder-reborn/releases/) for Version 1.0.0 Full Changelog and Migration Guide.**
 
 ## Installation
 
@@ -113,66 +112,74 @@ try {
 
 ### Geocode Address
 
-* `Geocoder.geocodeAddress(address: string, options?: GeocoderOptions)`
+* __`Geocoder.geocodeAddress(address: string, options?: GeocoderOptions)`__
 
-* Returns `Promise<GeocodingObject[]>`
+  * Returns `Promise<GeocodingObject[]>`
 
-* Supports `regionIos` on iOS.
+  * Supports `regionIos` on iOS for preferred search boundary.
 
-* Supports `bounds` on Android and Google Maps API.
+  * Supports `bounds` on Android and Google Maps API.
 
 ### Geocode Position (Reverse Geocoding)
 
-* `Geocoder.geocodePosition(position: { lat: number, lng: number }, options?: GeocoderOptions)`
+* __`Geocoder.geocodePosition(position: { lat: number, lng: number }, options?: GeocoderOptions)`__
 
-* Returns `Promise<GeocodingObject[]>`
+  * Returns `Promise<GeocodingObject[]>`
 
 ### `GeocoderOptions`
 
 ```typescript
 {
-  // Your Google Maps API key, required if when `fallbackToGoogle` or `forceGoogleOnIos` is set. Make sure Geocoding API is enabled.
+  // Your Google Maps API key, required if `fallbackToGoogle` or `forceGoogleOnIos` is `true`.
   apiKey?: string;
 
   // Preferred Locale for outputs, defaults to 'en'. (See Note 1)
   locale?: string;
 
-  // (Not available for Google Maps) Maximum returned results, defaults to 5
+  // Max number of addresses to return, defaults to 2. (See Note 2)
   maxResults?: number;
 
-  // (Android and Google only) Set the bounds for address geocoding. (See Note 2)
+  // (Android and Google only) Set the bounds for address geocoding. (See Note 3)
   bounds?: {
-    sw: { lat: number, lng: number }, // Lower left corner
-    ne: { lat: number, lng: number }, // Upper right corner
+    // Lower left corner
+    sw: { lat: number, lng: number },
+
+    // Upper right corner
+    ne: { lat: number, lng: number },
   };
 
-  // (iOS native only) Set circular region for address geocoding. (See Note 2)
+  // (iOS native only) Set circular region for address geocoding. (See Note 3)
   regionIos?: {
-    center: { lat: number, lng: number }, // Center of the circular region
-    radius: number, // Radius of the circular region. Unit: km
+    // Center of the circular region
+    center: { lat: number, lng: number },
+
+    // Radius of the circular region. Unit: km
+    radius: number,
   };;
 
   // Should use Google Maps API if native query fails, defaults to false.
   fallbackToGoogle?: boolean;
 
-  // Should always use Google Maps API on iOS, defaults to false. (See Note 3)
+  // Should always use Google Maps API on iOS, defaults to false. (See Note 4)
   forceGoogleOnIos?: boolean;
 
-  // Custom headers when sending Google Maps API requests. (See Note 4)
+  // Custom headers when sending Google Maps API requests. (See Note 5)
   requestHeaders?: { [key: string]: string };
 }
 ```
 #### Notes:
 
 1. Platforms may have different implantations for locale preference. Here is [Google Maps API supported language list](https://developers.google.com/maps/faq#languagesupport).
 
+2. Generally, only one entry will return, though the geocoder may return several results when address queries are ambiguous. Smaller numbers (1 to 5) for `maxResults` are recommended.
+
 2. On iOS the preferred search boundary for address geocoding only support "circular" region, while on Android and Google Maps API it using "rectangular" bounds. `regionIos` will have no effect if `forceGoogleOnIos` is `true`.
 
 3. Use `forceGoogleOnIos` if you want consistent result on both iOS and Android platform, due to the limitation of iOS native implantation.
 
 4. `requestHeaders` is useful together with Google API credentials restrictions by setting the `Referer` header. See [#20](https://github.com/timwangdev/react-native-geocoder-reborn/issues/20).
 
-5. In order to avoid hitting rate limit or reducing API queries, you could cache the results in your program whenever possible.
+5. In order to avoid hitting rate limit or reducing API queries, you should cache the results in your program whenever possible.
 
 ### `GeocodingObject`
 

src/geocoder.ts

@@ -7,7 +7,7 @@ let defaultOptions = {
   locale: 'en',
   fallbackToGoogle: false,
   forceGoogleOnIos: false,
-  maxResults: 5,
+  maxResults: 2,
 };
 
 function getApiKey(apiKey?: string) {