S-Dreamer commited on
Commit
11ca274
·
verified ·
1 Parent(s): 7e4a452

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -2
README.md CHANGED
@@ -38,6 +38,29 @@ CodeWatcher automatically:
38
  ```bash
39
  mkdir -p .github/workflows
40
  curl -o .github/workflows/codewatcher.yml https://raw.githubusercontent.com/your-org/CodeWatcher/main/.github/workflows/codewatcher.yml
41
- ```
42
 
43
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
  ```bash
39
  mkdir -p .github/workflows
40
  curl -o .github/workflows/codewatcher.yml https://raw.githubusercontent.com/your-org/CodeWatcher/main/.github/workflows/codewatcher.yml
41
+ ```
42
 
43
+ 2. Create the scripts directory:
44
+ ```bash
45
+ mkdir -p .github/scripts
46
+ curl -o .github/scripts/codewatcher.py https://raw.githubusercontent.com/your-org/CodeWatcher/main/.github/scripts/codewatcher.py
47
+ ```
48
+
49
+ 3. Commit and push these changes to your repository:
50
+ ```bash
51
+ git add .github
52
+ git commit -m "Add CodeWatcher security review workflow"
53
+ git push
54
+ ```
55
+
56
+ ## Configuration
57
+
58
+ Customize CodeWatcher by adding these files to your repository root:
59
+
60
+ - `.pylintrc` - Pylint configuration
61
+ - `.bandit` - Bandit configuration
62
+ - `.semgrep.yml` - Custom Semgrep rules
63
+
64
+ ## Example Output
65
+
66
+ ![CodeWatcher in action](https://github.com/your-org/CodeWatcher/raw/main/images/example-comment.png)