Skip to content

Commit 42042ec

Browse files
authoredJan 14, 2025··
Update README.md
1 parent 8f5b8cb commit 42042ec

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed
 

‎README.md

+26-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,36 @@ Search for any place in any language in earth.
88
<img src="irem-icon.png" alt="Logo" width="200"/>
99
</p>
1010

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+
1130
## Usage
1231

13-
### Use API
32+
### Use [npm](https://www.npmjs.com/package/irem)
33+
34+
Run command `npm i irem`
35+
36+
### Use free API
1437

1538
[Search for "Keçi" in Turkish](https://vakit.vercel.app/api/searchPlaces?q=Keçi&lang=tr)
1639

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)
1841

1942
[Nearby places around Ankara,Turkiye](https://vakit.vercel.app/api/nearByPlaces?lat=40.0006929&lng=32.8519762&lang=tr)
2043

@@ -26,16 +49,12 @@ Works only in nodejs environment. Stores data in the folder named `data` in TSV
2649
<img src="recording.gif" alt="Logo" width="750"/>
2750
</p>
2851

29-
### Use [npm](https://www.npmjs.com/package/irem)
30-
31-
Run command `npm i irem`
52+
## Documentation
3253

3354
### import ESM module
3455

3556
`import { getPlaceSuggestionsByText, getNearbyPlaces, getPlaceById } from 'irem';`
3657

37-
## Documentation
38-
3958
### function getPlaceSuggestionsByText
4059

4160
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

Comments
 (0)
Please sign in to comment.