Add README and API docs
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# @remotestorage/module-places
|
||||
|
||||
This module allows you to manage saved places (Points of Interest) using the [remoteStorage](https://remotestorage.io/) protocol.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pnpm add @remotestorage/module-places
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
import RemoteStorage from 'remotestoragejs';
|
||||
import PlacesModule from '@remotestorage/module-places';
|
||||
|
||||
const remoteStorage = new RemoteStorage({
|
||||
modules: [PlacesModule],
|
||||
});
|
||||
|
||||
// Access the module
|
||||
const places = remoteStorage.places;
|
||||
|
||||
// Store a place
|
||||
await places.store({
|
||||
title: 'My Favorite Coffee Shop',
|
||||
lat: 52.520008,
|
||||
lon: 13.404954,
|
||||
});
|
||||
|
||||
// List all places
|
||||
const allPlaces = await places.getPlaces();
|
||||
console.log(allPlaces);
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### Interfaces
|
||||
|
||||
- [PlacesClient](docs/interfaces/PlacesClient.md)
|
||||
|
||||
### Type Aliases
|
||||
|
||||
- [Place](docs/type-aliases/Place.md)
|
||||
Reference in New Issue
Block a user