Commits

Tim Tomes committed 449d5d8

renamed and updated the readme file.

Comments (0)

Files changed (2)

README

-Usage
------
-
-1. Install pre-requisites.
-
-  - Captures require PyQt4 or Phantomjs (recommended).
-  - Phantomjs:
-
-    + Compile Phantomjs and place the binary in the same directory as the source files.
-    + Make sure the binary is called "phantomjs".
-
-2. Run the script.
-
-  - python ./peepingtom.py -h
-
-Changelog
----------
-
-  v1.2 (11.26.12)
-
-  - cleaned up the code for release
-
-  v1.1 (7.15.12)
-
-  - no longer freezes on redirects to 401 authentication.
-  - stores each run in a unique directory.
-  - shows headers for final destination rather than redirect.
-  - denotes redirect next to the status header.
-
-Notes
------
-
-* Keep in mind that there is no good way to follow a JavaScript redirect in an automated fashion. Pages using JavaScript to redirect the browser will show up as a blank screen shot.
-* Increased verbosity will show a lot of errors from Phantomjs and PyQt4. Most of these are debugging errors and will not impact the fidelity of the report.
+# PeepingTom
+
+## Usage
+
+1. Install pre-requisites.
+
+    - Captures require PyQt4 or Phantomjs.
+    - Phantomjs (recommended):
+
+        + Compile Phantomjs and place the binary in the same directory as the source files.
+        + Make sure the binary is called "phantomjs".
+
+2. Run the script.
+
+ - python ./peepingtom.py -h
+
+## Changelog
+
+### v1.2 (11.26.12)
+
+ - cleaned up the code for release
+
+### v1.1 (7.15.12)
+
+ - no longer freezes on redirects to 401 authentication.
+ - stores each run in a unique directory.
+ - shows headers for final destination rather than redirect.
+ - denotes redirect next to the status header.
+
+## Notes
+
+ - Keep in mind that there is no good way to follow a JavaScript redirect in an automated fashion. Pages using JavaScript to redirect the browser will show up as a blank screen shot.
+ - Increased verbosity will show a lot of errors from Phantomjs and PyQt4. Most of these are debugging errors and will not impact the fidelity of the report.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.