1.1.3

README.md

@@ -1,7 +1,11 @@
 # @remotestorage/module-places
 
+[![npm version](https://img.shields.io/npm/v/@remotestorage/module-places.svg)](https://www.npmjs.com/package/@remotestorage/module-places)
+
 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
@@ -31,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

dist/places.d.ts

@@ -83,7 +83,7 @@ export interface PlacesClient {
     /**
      * Store a place.
      * Generates ID and Geohash if missing.
-     * Path structure: <geohash-prefix-2>/<geohash-prefix-2>/<id>
+     * Path structure: `<geohash-prefix-2>/<geohash-prefix-2>/<id>`
      *
      * @param placeData - The data of the place to store.
      * @returns The stored place object.

dist/places.js

@@ -71,7 +71,7 @@ const Places = function (privateClient /*, publicClient: BaseClient */) {
         /**
          * Store a place.
          * Generates ID and Geohash if missing.
-         * Path structure: <geohash-prefix-2>/<geohash-prefix-2>/<id>
+         * Path structure: `<geohash-prefix-2>/<geohash-prefix-2>/<id>`
          */
         store: async function (placeData) {
             const place = preparePlace(placeData);

docs/interfaces/PlacesClient.md

@@ -118,7 +118,7 @@ The geohash of the place.
 
 Store a place.
 Generates ID and Geohash if missing.
-Path structure: <geohash-prefix-2>/<geohash-prefix-2>/<id>
+Path structure: `<geohash-prefix-2>/<geohash-prefix-2>/<id>`
 
 #### Parameters
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@remotestorage/module-places",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@remotestorage/module-places",
-      "version": "1.1.0",
+      "version": "1.1.3",
       "license": "MIT",
       "dependencies": {
         "latlon-geohash": "^2.0.0",

package.json

@@ -1,7 +1,16 @@
 {
   "name": "@remotestorage/module-places",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "description": "Manage favorite/saved places",
+  "homepage": "https://gitea.kosmos.org/raucao/remotestorage-module-places#remotestoragemodule-places",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitea.kosmos.org/raucao/remotestorage-module-places.git"
+  },
+  "keywords": [
+    "remotestorage",
+    "remotestorage-module"
+  ],
   "main": "dist/places.js",
   "types": "dist/places.d.ts",
   "type": "module",

src/places.ts

@@ -56,7 +56,7 @@ export interface PlacesClient {
   /**
    * Store a place.
    * Generates ID and Geohash if missing.
-   * Path structure: <geohash-prefix-2>/<geohash-prefix-2>/<id>
+   * Path structure: `<geohash-prefix-2>/<geohash-prefix-2>/<id>`
    *
    * @param placeData - The data of the place to store.
    * @returns The stored place object.
@@ -157,7 +157,7 @@ const Places = function (
     /**
      * Store a place.
      * Generates ID and Geohash if missing.
-     * Path structure: <geohash-prefix-2>/<geohash-prefix-2>/<id>
+     * Path structure: `<geohash-prefix-2>/<geohash-prefix-2>/<id>`
      */
     store: async function (placeData: Partial<Place>) {
       const place = preparePlace(placeData);