Update README.md (#135)

Co-authored-by: Will <[email protected]>
faros-ai · May 1, 2023 · 51a3d9a · 51a3d9a
1 parent 21ad82c
commit 51a3d9a
Showing 1 changed file with 40 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -37,39 +37,46 @@ The QueryBuilder class is a utility to help construct GraphQL mutations from Far
 Example constructing the GraphQL mutation that upserts an application and deployment.
 
 ```ts
-    // The QueryBuilder manages origin for you
-    const qb = new QueryBuilder(ORIGIN);
-
-    const application: MutationParams = {
-      model: 'compute_Application',
-      key: {
-        name: '<application_name>',
-        platform: '<application_platform>',
-      },
-    };
-    const deployment: MutationParams = {
-      model: 'cicd_Deployment',
-      key: {
-        uid: '<deployment_uid',
-        source: '<deployment_source>',
-      },
-      body: {
-        // Fields that reference another model need to be refs
-        application: qb.ref(application),
-        status: {
-          category: 'Success',
-          detail: '<status_detail>',
-        },
-      },
-    };
-
-    const mutations = [
-      qb.upsert(application),
-      qb.upsert(deployment)
-    ];
-
-    // Send your mutations to Faros!
-    await client.sendMutations(mutations);
+import {QueryBuilder, FarosClient} from "faros-js-client";
+
+const faros = new FarosClient({
+    url: 'https://prod.api.faros.ai',
+    apiKey: '<your_faros_api_key>',
+});
+
+// The QueryBuilder manages the origin for you
+const qb = new QueryBuilder('example-origin');
+
+const application = {
+  model: 'compute_Application',
+  key: {
+    name: '<application_name>',
+    platform: '<application_platform>',
+  },
+};
+const deployment = {
+  model: 'cicd_Deployment',
+  key: {
+    uid: '<deployment_uid',
+    source: '<deployment_source>',
+  },
+  body: {
+    // Fields that reference another model need to be refs
+    application: qb.ref(application),
+    status: {
+      category: 'Success',
+      detail: '<status_detail>',
+    },
+  },
+};
+
+const mutations = [
+  qb.upsert(application),
+  qb.upsert(deployment)
+];
+
+// Send your mutations to Faros!
+await faros.sendMutations('default', mutations);
 ```
 
 Please read the [Faros documentation][farosdocs] to learn more.