@qssolutions/ssas-registration-form 1.0.6 → 1.0.8

package/README.md

@@ -20,12 +20,14 @@ npm install @qssolutions/ssas-registration-form
 
 ## Quick start (React)
 
+> **Only `partnerGuid` is required.** All other options are optional — if omitted, the form will automatically use partner's default configuration from the Self-service Assessment home page.
+
 ```tsx
 import React from 'react';
 import { SSASRegistrationForm, type FormLibraryConfig } from '@qssolutions/ssas-registration-form';
 
 const config: FormLibraryConfig = {
-  partnerName: 'MyPartner',
+  partnerGuid: 'your-partner-guid', // Contact QSSolutions to obtain your Guid
   theme: {
     primaryColor: '#00BAE4',
     backgroundColor: '#FCFCFF',
@@ -46,7 +48,9 @@ export default function App() {
 
 ## Quick start (Web Component)
 
-Use the browser bundle directly — no React installation needed:
+Use the browser bundle directly — no React installation needed.
+
+> **Only `partnerGuid` is required.** All other options are optional — if omitted, the form will automatically use partner's default configuration from the Self-service Assessment home page.
 
 ```html
 <script src="https://unpkg.com/@qssolutions/ssas-registration-form/dist/web-component.min.js"></script>
@@ -54,7 +58,7 @@ Use the browser bundle directly — no React installation needed:
 <script>
   const form = document.getElementById('registrationForm');
   form.config = {
-    partnerName: 'MyPartner',
+    partnerGuid: 'your-partner-guid', // Contact QSSolutions to obtain your Guid
     languageCode: 'en',
     theme: {
       primaryColor: '#00BAE4',
@@ -74,6 +78,8 @@ Use the browser bundle directly — no React installation needed:
 
 The Web Component bundle includes React internally — no extra dependencies needed.
 
+> **Only `partnerGuid` is required.** All other options are optional — if omitted, the form will automatically use partner's default configuration from the Self-service Assessment home page.
+
 ```ts
 // app.module.ts
 import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
@@ -104,7 +110,7 @@ export class RegistrationComponent implements AfterViewInit {
 
   ngAfterViewInit() {
     this.formEl.nativeElement.config = {
-      partnerName: 'MyPartner',
+      partnerGuid: 'your-partner-guid', // Contact QSSolutions to obtain your Guid
       languageCode: 'en',
       onSuccess: (email: string) => console.log('Success:', email),
       onError: (error: string) => console.error('Error:', error),
@@ -115,6 +121,8 @@ export class RegistrationComponent implements AfterViewInit {
 
 ## Quick start (Vue)
 
+> **Only `partnerGuid` is required.** All other options are optional — if omitted, the form will automatically use partner's default configuration from the Self-service Assessment home page.
+
 ```html
 <!-- index.html -->
 <script src="https://unpkg.com/@qssolutions/ssas-registration-form/dist/web-component.min.js"></script>
@@ -133,7 +141,7 @@ const form = ref(null)
 
 onMounted(() => {
   form.value.config = {
-    partnerName: 'MyPartner',
+    partnerGuid: 'your-partner-guid', // Contact QSSolutions to obtain your Guid
     languageCode: 'en',
     onSuccess: (email) => console.log('Success:', email),
     onError: (error) => console.error('Error:', error),
@@ -165,8 +173,9 @@ type SupportedLanguage =
 interface FormLibraryConfig {
   // ── Required ────────────────────────────────────────────────────────────────
 
-  // Partner identifier used for lookup and domain resolution
-  partnerName: string;
+  // Unique partner identifier (GUID) used for lookup and domain resolution.
+  // Contact QSSolutions to obtain your Guid.
+  partnerGuid: string;
 
   // ── Language ────────────────────────────────────────────────────────────────
 
@@ -248,7 +257,7 @@ customStyles: {
 
 ## Runtime flow
 
-1. Fetch partner record by `partnerName`
+1. Fetch partner record by `partnerGuid`
 2. Resolve partner domain → build service base URL (`https://{partner.domain}`)
 3. In parallel: fetch countries, org sizes, industries, localization
 4. Render form