@whereby.com/core 1.1.6 → 1.1.8

package/README.md

@@ -1,21 +1,85 @@
 # `@whereby.com/core`
 
-`@whereby.com/core` is an internal package containing business logic (API calls and state management etc.) to power the browser SDK, React Native and other forms of Whereby meetings. It also contains utils which may be useful in custom experiences.
+`@whereby.com/core` is the low-level foundation of the Whereby SDK. It exposes a set of containers, actions, and client classes for working with local media and room connections. It's used to power the [Whereby Browser SDK](https://github.com/whereby/sdk/tree/main/packages/browser-sdk), [Whereby Assistants](https://github.com/whereby/sdk/tree/main/packages/assistant-sdk) and [React Native SDK](https://github.com/whereby/sdk/tree/main/packages/react-native-sdk) and other forms of Whereby meetings. It also contains utils which may be useful in custom experiences.
+
+Use Core if you need **fine-grained control** over media and connections, or if you are building a custom integration outside of React. For most web apps, the Browser or React SDKs will be easier starting points.
 
 ## Installation
 
 ```shell
-npm install @whereby.com/browser-core
+npm install @whereby.com/core
 ```
 
 or
 
 ```shell
-yarn add @whereby.com/browser-core
+yarn add @whereby.com/core
 ```
 
 or
 
 ```shell
-pnpm add @whereby.com/browser-core
+pnpm add @whereby.com/core
 ```
+
+## Usage
+
+> [!IMPORTANT]
+> In order to use `@whereby.com/core`, you must have a Whereby account
+> from which you can create room URLs, either [manually or through the Whereby
+> API](https://docs.whereby.com/whereby-101/creating-and-deleting-rooms).
+
+### Getting Started
+
+```js
+import { WherebyClient } from "@whereby.com/core";
+
+const client = new WherebyClient();
+
+// manage local devices
+const localMedia = client.getLocalMedia();
+
+// manage room connection
+const roomConnection = client.getRoomConnection();
+```
+
+### Core Concepts
+
+#### Local Media
+
+The `LocalMediaClient` controls microphones, cameras and local media tracks. It provides methods to request permissions, start and stop tracks, and switch between devices. It also exposes state such as the list of available devices and the current active tracks.
+
+Typical usage:
+
+```js
+// you can pass options or a MediaStream
+await localMedia.startMedia({ audio: true, video: true });
+
+localMedia.toggleCamera(); // toggle camera on/off
+```
+
+#### Room Connection
+
+The `RoomConnectionClient` handles joining and leaving rooms, as well as observing connection and remote participant state.
+
+Typical usage:
+
+```js
+// initialize with your room URL
+roomConnection.initialize({
+    roomUrl: "https://your-subdomain.whereby.com/your-room",
+});
+
+// join the room
+roomConnection.joinRoom();
+
+// listen for changes in connection state
+roomConnection.subscribeToConnectionStatus((state) => {
+    console.log("Connection state changed:", state);
+});
+```
+
+### Learn More
+
+- Core SDK API Reference: [API Documentation](https://docs.whereby.com/reference/core-sdk-reference)
+- Core SDK Quick Start Guide: [Quick Start Guide](https://docs.whereby.com/reference/core-sdk-reference/quick-start)

package/dist/index.cjs

@@ -1147,7 +1147,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/dist/index.mjs

@@ -1145,7 +1145,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/dist/legacy-esm.js

@@ -1145,7 +1145,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/dist/redux/index.cjs

@@ -75,7 +75,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/dist/redux/index.js

@@ -73,7 +73,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/dist/redux/index.mjs

@@ -73,7 +73,7 @@ const createReactor = (selectors, callback) => {
     });
 };
 
-const coreVersion = "1.1.6";
+const coreVersion = "1.1.8";
 
 const initialState = {
     isNodeSdk: false,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@whereby.com/core",
   "description": "Core library for whereby.com sdk",
   "author": "Whereby AS",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -58,15 +58,15 @@
     "eslint": "^9.29.0",
     "prettier": "^3.5.3",
     "typescript": "^5.8.3",
+    "@whereby.com/eslint-config": "0.1.0",
     "@whereby.com/jest-config": "0.1.0",
-    "@whereby.com/tsconfig": "0.1.0",
     "@whereby.com/prettier-config": "0.1.0",
     "@whereby.com/rollup-config": "0.1.0",
-    "@whereby.com/eslint-config": "0.1.0"
+    "@whereby.com/tsconfig": "0.1.0"
   },
   "dependencies": {
     "@reduxjs/toolkit": "^2.2.3",
-    "@whereby.com/media": "2.1.4",
+    "@whereby.com/media": "2.1.5",
     "axios": "^1.11.0",
     "btoa": "^1.2.1",
     "events": "^3.3.0"