# Installation

The **gospace Floorplan SDK** (`@gospace-ai/floorplan`) can be installed via npm/yarn for use in modern JavaScript projects, or loaded directly in the browser via a public CDN.

***

### 1) Install via npm or yarn

```bash
npm install @gospace-ai/floorplan
```

or

```bash
yarn add @gospace-ai/floorplan
```

***

### 2) Import the SDK

**ESM (recommended)**

```ts
import Floorplan from "@gospace-ai/floorplan";
```

**CommonJS**

```js
const Floorplan = require("@gospace-ai/floorplan");
```

***

### 3) Use via CDN in Browser Environments

You can load the SDK without installing by using a public npm CDN such as **jsDelivr** or **unpkg**:

```html
<!-- Latest (auto-updates to the newest version) -->
<script src="https://cdn.jsdelivr.net/npm/@gospace-ai/floorplan@latest/dist/floorplan.umd.js"></script>

<!-- Or pin a specific version -->
<script src="https://cdn.jsdelivr.net/npm/@gospace-ai/floorplan@2.14.0/dist/floorplan.umd.js"></script>

<!-- unpkg alternative -->
<script src="https://unpkg.com/@gospace-ai/floorplan/dist/floorplan.umd.js"></script>
```

When loaded this way, the SDK is available as a global `Floorplan` object.

***

### 4) Requirements

* Node.js v18+ for local development
* A valid **access token** from gospace
* Supported browsers: Chrome, Edge, Safari, Firefox (latest two versions)
* Internet access to load the hosted floorplan at [**https://floorplan.gospace.app**](https://floorplan.gospace.app/)