You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+26-7
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,36 @@ Search for any place in any language in earth.
8
8
<img src="irem-icon.png" alt="Logo" width="200"/>
9
9
</p>
10
10
11
+
## Irem: A Multilingual Place Search API and Database for Developers
12
+
13
+
Irem is a Node.js library that integrates a comprehensive, well-structured geospatial database with an efficient querying API. Designed to simplify the integration of global place search functionality into applications, Irem supports multilingual searches, making it a versatile choice for modern, internationalized projects.
14
+
15
+
-**Extensive Geospatial Data:**
16
+
Access a meticulously curated database of over 350,000 entries, including cities, towns, regions, and other inhabited places worldwide, complete with GPS coordinates and alternative names.
17
+
18
+
-**Multilingual Search Support:**
19
+
Query place names in multiple languages, enabling seamless internationalization.
20
+
21
+
-**Integrated Querying Layer:**
22
+
Optimized API for performing precise and efficient place searches directly in your application.
23
+
24
+
-**Developer-Focused:**
25
+
Provides a straightforward and robust interface designed to minimize complexity and maximize performance.
26
+
27
+
-**Scalable and Flexible:**
28
+
Ideal for use cases ranging from mapping services and travel apps to e-commerce localization and geospatial analytics.
29
+
11
30
## Usage
12
31
13
-
### Use API
32
+
### Use [npm](https://www.npmjs.com/package/irem)
33
+
34
+
Run command `npm i irem`
35
+
36
+
### Use free API
14
37
15
38
[Search for "Keçi" in Turkish](https://vakit.vercel.app/api/searchPlaces?q=Keçi&lang=tr)
16
39
17
-
[Search for "随机" in English (default)](https://vakit.vercel.app/api/searchPlaces?q=随机)
40
+
[Search for "伊斯坦布尔" (Istanbul)](https://vakit.vercel.app/api/searchPlaces?q=%E4%BC%8A%E6%96%AF%E5%9D%A6%E5%B8%83%E5%B0%94)
18
41
19
42
[Nearby places around Ankara,Turkiye](https://vakit.vercel.app/api/nearByPlaces?lat=40.0006929&lng=32.8519762&lang=tr)
20
43
@@ -26,16 +49,12 @@ Works only in nodejs environment. Stores data in the folder named `data` in TSV
26
49
<img src="recording.gif" alt="Logo" width="750"/>
27
50
</p>
28
51
29
-
### Use [npm](https://www.npmjs.com/package/irem)
30
-
31
-
Run command `npm i irem`
52
+
## Documentation
32
53
33
54
### import ESM module
34
55
35
56
`import { getPlaceSuggestionsByText, getNearbyPlaces, getPlaceById } from 'irem';`
36
57
37
-
## Documentation
38
-
39
58
### function getPlaceSuggestionsByText
40
59
41
60
Returns a list of places based on search term in given language. if latitude and longitude is provided, the list is sorted by distance, otherwise sorted by text match. countryCode is a two letters string represents a country such as TR or US. If it's provided, results from the country will have precedence. maxResultCount is the size of returned array length. It should be in [0,100] range If language is undefined, results will be returned in English.
0 commit comments