From 0841e9856ee22cb772d69eff378034e384894fdb Mon Sep 17 00:00:00 2001 From: Christian Zirkelbach Date: Fri, 18 Oct 2024 11:05:35 +0200 Subject: [PATCH 1/3] Added quick start information on using polar --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffa55d0f6..122a54e42 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,16 @@ POLAR is ... ## Quick Start -Usage without NPM documented in chapter "Getting started (for developers)". +Usage without NPM is documented [here](###using-polar). + +### Installation (via NPM) ```bash npm i @polar/client-generic ``` +### Embedding POLAR +#### .js ```js import polar from '@polar/client-generic' @@ -39,6 +43,14 @@ polar.createMap({ }) ``` +#### .html +```html +
+``` + 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 From 68eb5045406002a4aee72d825b214590bffe9af5 Mon Sep 17 00:00:00 2001 From: Christian Zirkelbach Date: Fri, 18 Oct 2024 11:07:06 +0200 Subject: [PATCH 2/3] fix anchor link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 122a54e42..4161d4c2d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ POLAR is ... ## Quick Start -Usage without NPM is documented [here](###using-polar). +Usage without NPM is documented [here](##getting-started-for-developers). ### Installation (via NPM) From b14ec8c237939b643da75b05ea63de92207fb28e Mon Sep 17 00:00:00 2001 From: Christian Zirkelbach Date: Fri, 18 Oct 2024 11:08:33 +0200 Subject: [PATCH 3/3] fix anchor link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4161d4c2d..fd48cb993 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ POLAR is ... ## Quick Start -Usage without NPM is documented [here](##getting-started-for-developers). +Usage without NPM is documented [here](#getting-started-for-developers). ### Installation (via NPM)