@nextgis/geocoder 1.16.8 → 1.18.3

package/README.md

@@ -2,7 +2,13 @@
 
 ![size](https://img.shields.io/bundlephobia/minzip/@nextgis/geocoder) ![version](https://img.shields.io/npm/v/@nextgis/geocoder)
 
-Modern geocoder on async generators. May use different data providers.
+Geocoder is a versatile library designed for intuitive geocoding functionalities.
+With an emphasis on ease-of-use, it supports multiple providers to cater to diverse requirements, allowing developers to seamlessly integrate geocoding into their applications.
+
+## Built-in providers
+
+- NgwProvider: Specifically for the NGW vector layer, ideal for applications that rely on NextGIS services.
+- NominatimProvider: Utilizes the Nominatim geocoding service, suitable for applications requiring free geocoding services with OpenStreetMap data.
 
 ## Installation
 
@@ -48,12 +54,41 @@ $ yarn add @nextgis/geocoder
 
 ## Usage
 
-```javascript
-import { Geocoder } from '@nextgis/geocoder';
+### Basic Usage with NGW Provider
 
-const ngwConnector = new Geocoder({
-  ...options
+```javascript
+import { Geocoder, NgwProvider } from '@nextgis/geocoder';
+
+// Initialize the NGW Provider
+const ngwProvider = new NgwProvider({
+    connectorOptions: {
+        baseUrl: 'https://demo.nextgis.com',
+    },
+    searchResources: [
+        {
+            resourceId: 4224,
+            limit: 3,
+        },
+        // ... other resources
+    ],
 });
+
+// Initialize the geocoder
+const geocoder = new Geocoder({ providers: [ngwProvider] });
+
+// Use geocoder.search() for geocoding queries
+const searchQuery = "example_search_query"; // Replace with your search term
+const geocoderGenerator = geocoder.search(searchQuery);
+
+// Iterate over the geocoder generator to get the search results
+for await (const item of geocoderGenerator) {
+    console.log(item.text); // Log the item name or description
+    item.result().then(({ extent }) => {
+        // Use the result's extent or other properties as needed
+        console.log(extent);
+    });
+    break;
+}
 ```
 
 Check out the [API Documentation](https://code-api.nextgis.com/modules/geocoder.html)