Skip to content

Commit 1cb2a08

Browse files
authored
Update README.md
1 parent 882c6a1 commit 1cb2a08

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Commit Watcher finds interesting and potentially hazardous commits in git projects. Watch your own projects to make sure you didn't accidentally leak your AWS keys or other credentials, and watch open-source projects you use to find undisclosed security vulnerabilities and patches.
44

5-
At [SourceClear](https://srcclr.com/), we want to help you use open-source software safely. Oftentimes when a security vulnerability is discovered and fixed in an open-source project, there isn't a public disclosure about it. In part, this is because the [CVE](https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures) process is onerous and labor intensive, and notifying all the users of a project isn't possible.
5+
At [SourceClear](https://www.sourceclear.com/), we want to help you use open-source software safely. Oftentimes when a security vulnerability is discovered and fixed in an open-source project, there isn't a public disclosure about it. In part, this is because the [CVE](https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures) process is onerous and labor intensive, and notifying all the users of a project isn't possible.
66

77
Oh, and about that UI. Commit Watcher is intended to be an API accessible backend service. The UI is only there for testing, and the scope of functionality is limited to collecting commits and auditing them against a set of rules.
88

@@ -14,6 +14,13 @@ Additionally, if you find a security issue on an open-source project using Commi
1414

1515
## Setup
1616

17+
Install and configure Ruby using RVM or Rbenv. Avoid using the system's bundled Ruby to avoid permission issues during installation/setup.
18+
19+
```bash
20+
RVM: https://rvm.io
21+
Rbenv: https://github.com/rbenv/rbenv
22+
```
23+
1724
Install MySQL and Redis. On Mac, with Brew, you can do that with this command:
1825

1926
```bash
@@ -55,7 +62,7 @@ If you'd like to use another email provider other than Gmail, you'll have to cha
5562
Create the database, load the schema, and seed it with some sample rules:
5663

5764
```bash
58-
rake db:setup
65+
rails db:setup
5966
```
6067

6168
Now you're ready to start Rails with:

0 commit comments

Comments
 (0)