Documentation

README.md

@@ -17,7 +17,7 @@ Contributing
 
 **Adding a new application**
 
-* Edit share/apps.js
+* Edit `share/apps.js`
 * Add a 16x16 PNG image to `share/images/icons` matching the application name.
 * Provide the URL to the application's website when submitting a pull request.
 
@@ -25,19 +25,15 @@ Example:
 
 ```javascript
 'Application Name': { 
-	cats: [ 1 ], 
-	headers: {
-		'X-Powered-By': /Application Name/,
-		},
-	html: /<link[^>]application-name\.css/i, 
-	url: /.+\.application-name\.com/i
-	meta: {
-		'generator': /Application Name/i
-		},
-	script: /application-name\.js/i,
-	env: /ApplicationName/
+	cats:    [ 1 ], 
+	headers: { 'X-Powered-By': /Application Name/i },
+	url:     /.+\.application-name\.com/,
+	html:    /<link[^>]application-name\.css/, 
+	meta:    { 'generator': /Application Name/i },
+	script:  /application-name\.js/,
+	env:     /ApplicationName/,
 	implies: [ 'PHP' ]
-	},
+	}
 ```
 
 
@@ -45,27 +41,29 @@ Drivers
 -------
 
 Wappalyzer is multi-platform. The main code lives in the `share/` directory and
-platform specific code in `drivers/`.
+platform specific code in `drivers/`. The sections below describe how to set up
+a development environment for the various existing drivers.
 
-The sections below describe how to set up a development environment for the
-various existing drivers.
+To keep files synchronised between drivers, run the `links.sh` script (UNIX-like 
+system only, Windows user will have to manually copy the files across.)
 
-To keep files synchronised between drivers, run the `links.sh` script (on
-UNIX-like system only.)
 
-
-**Firefox**
+**Mozilla Firefox**
 
 * Place a file called `wappalyzer@crunchlabz.com` in the extensions directory in
   your [profile folder](http://kb.mozillazine.org/Profile_folder_-_Firefox) 
-	(`.mozilla/firefox/xxxxx.default/extensions/` on Linux) containing the full
+	(`~/.mozilla/firefox/xxxxx.default/extensions/` on Linux) containing the full
 	path to `drivers/firefox`.
 * Restart Firefox
 * Navigate to `about:config` and set `extensions.wappalyzer.debug` to `true`.
 * Ctrl+Shift+J brings up a console for debugging.
 
 
-**Chrome**
+**Google Chrome**
+
+The Chrome version needs some love, if anyone wants to pick it up. It's
+currently not as feature-rich as the Firefox add-on (although partially due to 
+API limitations.)
 
 * Navigate to `about:extensions`
 * Check "Developer mode"
@@ -81,6 +79,11 @@ want to port Wappalyzer to a new platform.
 * Navigate to `drivers/html/`
 
 
+**Bookmarklet**
+
+Work in progress.
+
+
 Screenshot
 ----------