Documentation

main
ElbertF 13 years ago
parent d57e383648
commit dd42af58c7

@ -17,7 +17,7 @@ Contributing
**Adding a new application** **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. * 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. * Provide the URL to the application's website when submitting a pull request.
@ -26,18 +26,14 @@ Example:
```javascript ```javascript
'Application Name': { 'Application Name': {
cats: [ 1 ], cats: [ 1 ],
headers: { headers: { 'X-Powered-By': /Application Name/i },
'X-Powered-By': /Application Name/, url: /.+\.application-name\.com/,
}, html: /<link[^>]application-name\.css/,
html: /<link[^>]application-name\.css/i, meta: { 'generator': /Application Name/i },
url: /.+\.application-name\.com/i script: /application-name\.js/,
meta: { env: /ApplicationName/,
'generator': /Application Name/i
},
script: /application-name\.js/i,
env: /ApplicationName/
implies: [ 'PHP' ] implies: [ 'PHP' ]
}, }
``` ```
@ -45,27 +41,29 @@ Drivers
------- -------
Wappalyzer is multi-platform. The main code lives in the `share/` directory and 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 To keep files synchronised between drivers, run the `links.sh` script (UNIX-like
various existing drivers. 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.)
**Mozilla Firefox**
**Firefox**
* Place a file called `wappalyzer@crunchlabz.com` in the extensions directory in * Place a file called `wappalyzer@crunchlabz.com` in the extensions directory in
your [profile folder](http://kb.mozillazine.org/Profile_folder_-_Firefox) 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`. path to `drivers/firefox`.
* Restart Firefox * Restart Firefox
* Navigate to `about:config` and set `extensions.wappalyzer.debug` to `true`. * Navigate to `about:config` and set `extensions.wappalyzer.debug` to `true`.
* Ctrl+Shift+J brings up a console for debugging. * 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` * Navigate to `about:extensions`
* Check "Developer mode" * Check "Developer mode"
@ -81,6 +79,11 @@ want to port Wappalyzer to a new platform.
* Navigate to `drivers/html/` * Navigate to `drivers/html/`
**Bookmarklet**
Work in progress.
Screenshot Screenshot
---------- ----------