diff --git a/README.md b/README.md index 7557bf1a..0faf673d 100644 --- 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'],