@proximahq-dev/map 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,26 @@
1
+ # How to use
2
+
3
+ ### Import component style at the top of the page
4
+
5
+ ```<link rel="stylesheet" href="https://unpkg.com/@proximahq-dev/map@latest/dist/map-styles.css">```
6
+
7
+ ### Import mapbox style at the top of the page
8
+
9
+ ```<link rel="stylesheet" href="https://unpkg.com/@proximahq-dev/map@latest/dist/styles.css">```
10
+
11
+ ### Create a wrapper element to contain the component
12
+
13
+ ```<div id="mapContainer" />```
14
+
15
+ ### Add a script at the bottom of the body
16
+
17
+ ```<script src="https://unpkg.com/@proximahq-dev/map@latest/dist/proxima-map.umd.js"></script>```
18
+
19
+ ```flow js
20
+ <script>
21
+ const map = new ProximaMap({
22
+ projectSlug: 'slug (e.g. nikola)',
23
+ });
24
+ map.initMap("mapContainer");
25
+ </script>;
26
+ ```