@archilogic/floor-plan-sdk 5.0.0-beta.0

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,31 @@
1
+ # Floor Plan SDK
2
+
3
+ The @archilogic/floor-plan-sdk package enables you to create and embed interactive, customizable floor plans in the browser
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm i @archilogic/floor-plan-sdk
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ### npm package
14
+ ```bash
15
+ npm i @archilogic/floor-plan-sdk
16
+ ```
17
+ ```js
18
+ import { FloorPlanEngine } from '@archilogic/floor-plan-sdk'
19
+ ```
20
+
21
+ ### es module import via CDN
22
+ ```js
23
+ import { FloorPlanEngine } from 'https://code.archilogic.com/fpe-sdk/v5.0.0-beta.0/fpe.es.js'
24
+ ```
25
+
26
+ ### umd module import via CDN
27
+ ```html
28
+ <script src="https://code.archilogic.com/fpe-sdk/v5.0.0-beta.0/fpe.umd.js" >
29
+ ```
30
+
31
+