Skip to content
Browse files

add doc for rails_brakeman service

  • Loading branch information...
1 parent a9d7042 commit 5a1c038f81097e2d019debaea9a44843b4133ac6 @flyerhzm flyerhzm committed May 19, 2012
Showing with 26 additions and 0 deletions.
  1. +26 −0 docs/rails_brakeman
View
26 docs/rails_brakeman
@@ -0,0 +1,26 @@
+RailsBrakeman
+=============
+
+RailsBrakeman - an online service to find security issues in your rails projectis.
+
+Install Notes
+-------------
+
+1. Create an account on rails-brakeman.com (just sign in with GitHub)
+2. Create a repository on rails-brakeman.com
+3. Enter your token
+ - the token which you can find on repository edit page on rails-brakeman.com
+4. Enter your rails_brakeman_url if you deploy the proxy on your own server
+5. Check the "Active" checkbox and click "Update Settings"
+
+For more details about RailsBrakeman, go to https://rails-brakeman.com
+
+Developer Notes
+---------------
+
+data
+ - rails_brakeman_url
+ - token
+
+payload
+ - refer to docs/github_payload

0 comments on commit 5a1c038

Please sign in to comment.
Something went wrong with that request. Please try again.