@roomle/web-sdk-types 0.0.0 → 5.1.0-typestest.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 CHANGED
@@ -1 +1,17 @@
1
- "Placeholder, real releases follow with the next Web SDK types release"
1
+ # Roomle Web SDK Types
2
+
3
+ TypeScript declarations of the [Roomle](https://www.roomle.com/en) Web SDK, without the SDK runtime.
4
+
5
+ Use this package when you only need the types, for example in a shared type package or in a library that talks to the SDK through an iframe. If your code runs the SDK, install [`@roomle/web-sdk`](https://www.npmjs.com/package/@roomle/web-sdk) instead: it ships the same declarations.
6
+
7
+ ```bash
8
+ npm install --save-dev @roomle/web-sdk-types
9
+ ```
10
+
11
+ ```ts
12
+ import type { RoomleConfigurator } from '@roomle/web-sdk-types';
13
+ ```
14
+
15
+ The version always matches the `@roomle/web-sdk` release it was built from.
16
+
17
+ For release notes, see the [CHANGELOG](https://docs.roomle.com/rubens/changelogs/changelog-1).