Merge pull request #217 from CrowdStrike/0.3.2-dev

0.3.2 dev

.gitignore

@@ -2,5 +2,8 @@
 /node_modules/
 /specs/*
 !/specs/transformation.*
+/src/tests/*
+/src/test.ts
 typings
 *.js
+.DS_Store

README.md

@@ -19,6 +19,10 @@ npm install crowdstrike-falcon
 
 ## Exemplary use
 
+With falconjs, there are two ways to call CrowdStrike API service collections. You can use the FalconClient object, which has always been available, or you can use the new Falcon object, which behaves like the API Harness, or UberClass, from FalconPy.
+
+### FalconClient
+
 ```typescript
 import { FalconClient, FalconErrorExplain } from "crowdstrike-falcon";
 
@@ -37,6 +41,31 @@ await client.sensorDownload
         console.log("my CCID: ", value);
     });
 ```
+## Falcon
+when using request body properties:
+```js
+const body = { ids: ["123", "456", "789"]}
+try {
+    detDetails = await falcon.command("GetDetectSummaries", body)
+    return detDetails
+} catch (error) {
+    console.log(error)
+    return
+}
+```
+
+when using query params:
+```js
+const params = { filter: "score:<=75"}
+const args = {"getAssessmentsByScoreV1", params }
+try {
+    ztaDetails = await falcon.command(args)
+    return ztaDetails
+} catch(error) {
+    console.log(error)
+    return
+}
+```
 
 ## Documentation