Skip to content

Commit

Permalink
Merge pull request #200 from Dataport/documentation/readme
Browse files Browse the repository at this point in the history
Documentation/readme
  • Loading branch information
czirkelbach authored Oct 25, 2024
2 parents 7afd7e5 + a9d994f commit b364f2b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,16 @@ POLAR is ...

## Quick Start

Usage without NPM documented in chapter "Getting started (for developers)".
Usage without NPM is documented [here](#getting-started-for-developers).

### Installation (via NPM)

```bash
npm i @polar/client-generic
```

### Embedding POLAR
#### .js
```js
import polar from '@polar/client-generic'

Expand All @@ -39,6 +43,14 @@ polar.createMap({
})
```

#### .html
```html
<div
style="width: 680px; height: 420px; position: relative;"
id="polarstern"
/>
```

See our [documentation page](https://dataport.github.io/polar/) for all features and configuration options included in this modulith client, with running examples.

## Example clients
Expand Down

0 comments on commit b364f2b

Please sign in to comment.