search-google-geocode - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "search-google-geocode",
-  "version": "0.0.5",
-  "description": "Public search geographical place using Google Geocoding API",
+  "version": "0.0.6",
+  "description": "Public search geographical location or address using Google Geocoding API: [reverse] geocoding.",
   "main": "index.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -1,1 +0,47 @@
-Simple module used to search place with Google geocoding API
+##google-geocoder
+
+### General
+
+Node.js module for geocoding and reverse geocoding.  
+[**Uses service Google geocoding API.**](https://developers.google.com/maps/documentation/geocoding)
+
+[Geocoding](https://developers.google.com/maps/documentation/geocoding/#Geocoding) is the process of matching address with geographic coordinates.  
+[Reverse Geocoding](https://developers.google.com/maps/documentation/geocoding/#ReverseGeocoding) is the process of matching geographic coordinates with address.
+
+[*Address geocoding.*](https://developers.google.com/maps/documentation/geocoding/#GeocodingRequests) Provide an address or location and receive potential Google geocodes.  
+[*Reverse geocoding.*](https://developers.google.com/maps/documentation/geocoding/#reverse-example) Provide latitude and longitude coordinates and receive the known address information for that location.
+
+[Output format like JSON](https://developers.google.com/maps/documentation/geocoding/#JSON)
+
+[Usage Limits](https://developers.google.com/maps/documentation/geocoding/#Limits)
+
+### Installation
+>npm install google-geocoder [-S]
+
+### Usage example
+```javascript
+// initialize geocoder instance
+var geocoder = require('google-geocoder');
+
+// request parameters
+const ADDRESS = 'Kyiv, Khreshchatyk';
+const LATITUDE = '50.45';
+const LONGITUDE = '30.523';
+const LANGUAGE = 'en';
+
+// you can use Google options to manage result format
+var options = {
+  language: LANGUAGE
+};
+
+// use callback to return result from geocoding process
+function callback (error, result) {
+  if (error) console.log(error); // on error
+  console.log(result); // on success
+}
+
+// address geocoding
+geocoder.geocode(ADDRESS, callback, options);
+// reverse geocoding
+geocoder.reverseGeocode(LATITUDE, LONGITUDE, callback, options);
+```

No alert changes

Improved metrics

Total package byte prevSize

9941

increased by21.48%

Number of lines in readme file

48

increased by2300%

No dependency changes