Improve README
This commit is contained in:
parent
b9615d7b97
commit
602cc44ae2
@ -4,6 +4,8 @@
|
||||
|
||||
This module allows you to manage saved places (Points of Interest) using the [remoteStorage](https://remotestorage.io/) protocol.
|
||||
|
||||
It leverages [Geohashes](https://www.geohash.es/) to organize data, enabling efficient retrieval of places within specific geographic areas. This structure is particularly optimized for map applications that need to load data only for the visible viewport.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
@ -33,6 +35,10 @@ await places.store({
|
||||
// List all places
|
||||
const allPlaces = await places.getPlaces();
|
||||
console.log(allPlaces);
|
||||
|
||||
// List places for specific geohash prefixes (e.g. for a map view)
|
||||
const areaPlaces = await places.getPlaces(['u33d', 'u33e']);
|
||||
console.log(areaPlaces);
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user