Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit b11b78c

Browse files
author
dpatanin
committed
remove temp files
1 parent 96af34c commit b11b78c

File tree

4 files changed

+20
-22
lines changed

4 files changed

+20
-22
lines changed

docs/developer-guide/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,17 @@ cd operator
8686
make run
8787
```
8888

89-
## How to a New Security Scanner
89+
## How to add a New Security Scanner
9090

9191
### ScanType Definition
9292

9393
### Parsing SDK
9494

95+
1. Install the dependencies `npm install`
96+
2. Update the parser function here: `./parser/parser.js`
97+
3. Update the parser tests here: `./parser/parser.test.js`
98+
4. Run the test suite: `npm test`
99+
95100
## How to Integrate a New Hook
96101

97102
### HookType Definition

docs/user-guide/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# Using the secureCodeBox
22

3+
### Local setup
4+
5+
1. Clone the repository `git clone [email protected]:secureCodeBox/secureCodeBox-v2-alpha.git`
6+
2. Ensure you have node.js installed
7+
* On MacOs with brew package manager: `brew install node`
8+
9+
## Deployment
10+
11+
Each scanType can be deployed via helm:
12+
13+
```bash
14+
helm upgrade --install <scannerName> ./scanners/<scannerName>/
15+
```
16+
317
follwing...

scanners/deployment.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

scanners/development.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)