Merge pull request #2 from DavidDurman/update-readme

update readme
clientIO · Feb 9, 2024 · c2d96f7 · c2d96f7
2 parents 1371a4a + ec15b9b
commit c2d96f7
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
-# appmixer-demo-embedded-integrations
+# Appmixer Embedded Integrations Demo
+
+Try live at:
+
+```
+https://demo-integrations.appmixer.com?apiUrl=https://api.YOUR_TENANT.appmixer.com&studioUrl=https://my.YOUR_TENANT.appmixer.com
+```
+
+The following query parameters are supported:
+
+| Query Parameter  | Required | Description | Example |
+| ------------- | ------------- | -------- | -------- |
+| `apiUrl`  | ✅ | The Appmixer Tenant API URL that you were assigned at sign-up.  | `https://api.YOUR_TENANT.appmixer.com` |
+| `studioUrl`  | ✅ | The Appmixer Tenant Studio URL that you were assigned at sign-up.  | `https://my.YOUR_TENANT.appmixer.com` |
+| `username`  |  | An Appmixer Virtual User Username. If not defined, a virtual user with a the following username will be created `[email protected]` (for demo purposes).  | `[email protected]` |
+| `token`  |  | An Appmixer Virtual User Token.  | `d17e3798-d754-4397-aff2-f06e71c5ae57` |
+| `domainFilter`  |  | If specified, only integrations pubslihed to this specific domain will be displayed. Otherwise, integrations published to all users will be displayed.  | `myapp.com` |
+
+
+![Screenshot](assets/screenshot.png?raw=true "Screenshot")
diff --git a/github-mark.svg → assets/github-mark.svg b/github-mark.svg → assets/github-mark.svg
diff --git a/assets/screenshot.png b/assets/screenshot.png
diff --git a/yoursaas.svg → assets/yoursaas.svg b/yoursaas.svg → assets/yoursaas.svg
diff --git a/index.html b/index.html
@@ -9,7 +9,7 @@
 <body>
     <div class="container">
         <div class="guide">
-            <img id="yoursaas" src="./yoursaas.svg" />
+            <img id="yoursaas" src="./assets/yoursaas.svg" />
 
             <h1>Appmixer Embedded Integrations Demo</h1>
             <p>This demo shows you how to embed Appmixer Integrations in your own web application.</p>
@@ -44,7 +44,7 @@ <h2>2. Trigger the integration by sending an App Event</h2>
         <input type="submit" value="Send App Event" />
     </form>
 
-            <a id="github-link" href="https://github.com/clientIO/appmixer-demo-embedded-integrations" target="_blank"><img src="./github-mark.svg" /></a>
+            <a id="github-link" href="https://github.com/clientIO/appmixer-demo-embedded-integrations" target="_blank"><img src="./assets/github-mark.svg" /></a>
         </div>
         <div class="app">
             <div id="appmixer-integrations-marketplace"></div>