Version Bump + Docs

sdk/README.md

@@ -18,29 +18,44 @@ yarn add @dimo-network/login-with-dimo
 ## Usage
 You can integrate the LoginWithDimo component into your React application to allow users to authenticate with Dimo. The component handles the authentication process in a popup window and triggers the appropriate callback functions upon success or error.
 
-### Example
+### Initialize DIMO SDK
 
 ```
-import { LoginWithDimo } from "@dimo-network/login-with-dimo";
-
-const YourComponent = () => {
-  const permissionsEnabled = true;  // Set permissions flag based on your app's requirements
-
-  return (
-    <LoginWithDimo
-      mode="redirect" //can be set to "redirect", "popup", or "embed"
-      onSuccess={(authData) => console.log("Success:", authData)}  // Success callback, will only trigger on "embed" or "popup" modes, authData is an object, with a "token" param which represents the users JWT
-      onError={(error) => console.error("Error:", error)}  // Error callback
-      clientId={process.env.REACT_APP_DIMO_CLIENT_ID}  // Your Dimo Client ID
-      redirectUri={process.env.REACT_APP_DIMO_REDIRECT_URI}  // Your redirect URI after login, this is relevant for the "redirect" mode
-      apiKey={process.env.REACT_APP_DIMO_API_KEY}  // Your Dimo API Key (optional)
-      permissionTemplateId={permissionsEnabled ? "1" : undefined}  // Permission template ID (optional, default to 1 if need to request permissions)
-      environment={process.env.REACT_APP_DIMO_ENV}  // Environment setting (e.g., "production" or "development"), de
-      // Optionally, specify vehicles (uncomment the line below to use it)
-      // vehicles={["585","586"]}  // Specify the vehicles to be accessed after login
-    />
-  );
-};
+import {
+  initializeDimoSDK,
+} from "@dimo-network/login-with-dimo";
+
+  initializeDimoSDK({
+    clientId: "YOUR CLIENT ID",
+    redirectUri: "YOUR REDIRECT URI",
+    apiKey: "YOUR API KEY",
+    environment: "development" | "production", 
+  });
 ```
 
+### Using the Button Components
 
+```
+import {
+  LoginWithDimo,
+  ShareVehiclesWithDimo,
+} from "@dimo-network/login-with-dimo";
+
+          <LoginWithDimo
+            mode="popup"
+            onSuccess={(authData) => console.log("Success:", authData)}
+            onError={(error) => console.error("Error:", error)}
+            permissionTemplateId={permissionsEnabled ? "1" : undefined} //This will control if your users are asked to share vehicles, as part of the login flow. "1" is the template for all SACD permissions
+            // Optionally, specify vehicles (uncomment the line below to use it)
+            // vehicles={["585","586"]}  // Specify the vehicles to be accessed after login            
+          />
+
+          <ShareVehiclesWithDimo
+            mode="popup"
+            onSuccess={(authData) => console.log("Success:", authData)}
+            onError={(error) => console.error("Error:", error)}
+            permissionTemplateId={"1"} //REQUIRED: "1" is the template for all SACD permissions
+            // Optionally, specify vehicles (uncomment the line below to use it)
+            // vehicles={["585","586"]}  // Specify the vehicles to be accessed when triggered   
+          />          
+```

sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimo-network/login-with-dimo",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",