Merge pull request #111 from snyk/chore/docs-update

fix: updated readme
snyk · Oct 13, 2021 · e0a3a1d · e0a3a1d
2 parents 418fecb + e18449b
commit e0a3a1d
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -88,11 +88,28 @@ Complete list of events:
 
 ### Run analysis
 
+```javascript
+const results = await codeClient.analyzeFolders({
+  connection: { baseURL, sessionToken, source },
+  analysisOptions: {
+    severity: 1
+  },
+  fileOptions: {
+    paths: ['/home/user/repo'],
+    symlinksEnabled: false,
+  },
+});
+
+```
+
+### Run analysis only for specific file, the one just changed for example
+
 ```javascript
 const results = await codeClient.analyzeFolders({
   connection: { baseURL, sessionToken, source },
   analysisOptions: {
     severity: 1,
+    limitToFiles: ['recently-changed-file.js']
   },
   fileOptions: {
     paths: ['/home/user/repo'],