Skip to content
Browse files

Updated Readme with better usage and installation

  • Loading branch information...
1 parent e3c80ac commit eae9608682cf3aab2ebc3ee9eb569fc164e383cf @AutomatedTester AutomatedTester committed May 19, 2011
Showing with 10 additions and 8 deletions.
  1. +10 −8 README.md
View
18 README.md
@@ -1,16 +1,18 @@
-Garmr
-=====
+# Garmr
Garmr is a checking that a site meets the basic requirements from a security point of view.
-It checks what the correct HTTP calls are allowed and others are blocked.
+It checks what the correct HTTP calls are allowed and others are blocked. It is installable from PyPi.
-Usage
-=====
+## Installation
-garmr.py -u http://application.under.test/path
+To install it is a simple case of
+ sudo pip install garmr
-Tasks
-=====
+## Usage
+
+garmr -u http://application.under.test/path
+
+## Tasks
If you want to see what is currently being worked on you can see it on the
(Pivotal Tracker)[https://www.pivotaltracker.com/projects/285905 "Tasks"]

0 comments on commit eae9608

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