@snugdesk/core 0.0.12 → 0.0.13

package/README.md

@@ -1,6 +1,6 @@
 # @snugdesk/core
 
-`@snugdesk/core` is the foundational library that powers all other Snugdesk widgets and libraries. It provides essential services and session management utilities required for seamless integration of Snugdesk modules such as `@snugdesk/avaya-ipo-widget`, `@snugdesk/whatsapp-widget`, and others.
+`@snugdesk/core` is the foundational Angular library that powers Snugdesk widgets and shared modules. It provides authentication, shared helpers, and other essential services required for seamless integration of Snugdesk modules such as `@snugdesk/avaya-ipo-widget`, `@snugdesk/whatsapp-widget`, and others.
 
 To purchase licenses or for assistance with implementing the Snugdesk libraries in your Angular web application, please contact:
 
@@ -34,13 +34,33 @@ npm install @angular/animations
 npm install @auth0/angular-jwt crypto-js moment-timezone uuid
 ```
 
-### Step 2. Install the package
+### Step 2: Install the package
 
 ```bash
 npm install @snugdesk/core
+npm install aws-amplify@^5 @aws-amplify/api-graphql@^3
 ```
 
-### 2. Initialize in your app (before loading any Snugdesk widget)
+Amplify v5 is required. Other Snugdesk widgets rely on this package for AppSync configuration.
+
+Peer dependency ranges (from the package manifest):
+- Angular: >=19.0.0
+- RxJS: ~7.8.0
+
+### Step 3: Setup
+
+#### 1) Import the module (if you use the shared components)
+
+```ts
+import { SnugdeskCoreModule } from '@snugdesk/core';
+
+@NgModule({
+  imports: [SnugdeskCoreModule],
+})
+export class AppModule {}
+```
+
+#### 2) Initialize authentication
 
 ```ts
 import { SnugdeskAuthenticationService } from '@snugdesk/core';
@@ -54,11 +74,15 @@ ngOnInit() {
 
 > Other Snugdesk libraries will automatically retrieve and reuse the session.
 
----
+## What you get
+- Authentication utilities (`SnugdeskAuthenticationService`)
+- Common pipes, components, and shared helpers
+- AppSync helper (`AppSyncHelperService`) that handles query/mutate/subscribe
+- GraphQL services and shared models used by Snugdesk widgets
 
-## 📌 License
+## Support and licensing
 
-This library is a proprietary product of Snugdesk and is protected under applicable intellectual property laws.
+This library is a proprietary product of Snugdesk and is protected under applicable intellectual property laws. 
 
 > **Note**: Usage of this library requires a valid license or an active Snugdesk subscription. Unauthorized distribution or usage is strictly prohibited.