@archilogic/floor-plan-sdk 3.1.6 → 3.1.7
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 +34 -0
- package/fpe.css +1 -1
- package/fpe.esm.js +2 -2
- package/fpe.js +2 -2
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
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
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
https://developers.archilogic.com/floor-plan-engine/guide.html
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
### npm package
|
|
12
|
+
```bash
|
|
13
|
+
npm i @archilogic/floor-plan-sdk
|
|
14
|
+
```
|
|
15
|
+
```js
|
|
16
|
+
// importing the npm package as ES module (recommended)
|
|
17
|
+
import FloorPlanEngine from '@archilogic/floor-plan-sdk'
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
```js
|
|
21
|
+
// importing the npm package as UMD bundle (when the global FloorPlanEngine variable is required)
|
|
22
|
+
import '@archilogic/floor-plan-sdk'
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### CDN
|
|
26
|
+
```js
|
|
27
|
+
// importing as ES module via public CDN (useful for environments where npm is not supported)
|
|
28
|
+
import FloorPlanEngine from 'https://unpkg.com/@archilogic/floor-plan-sdk?module'
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
```js
|
|
32
|
+
// importing as UMD module via public CDN
|
|
33
|
+
import 'https://unpkg.com/@archilogic/floor-plan-sdk'
|
|
34
|
+
```
|
package/fpe.css
CHANGED