Updated the readme with new method and new sample along with formatting update to match NPMJS.org

main
Johann du Toit 10 years ago
parent 6ebbc9f6e7
commit dc9ea3164d

@ -1,17 +1,25 @@
# Wappalyzer # Wappalyzer
This is npm module for wappalyzer ## Install
npm install wappalyzer Install wappalyzer from NPM with:
```bash
npm install wappalyzer
```
## Quickstart
```javascript
// load in the lib
var wappalyzer = require("wappalyzer"); var wappalyzer = require("wappalyzer");
// set our options
var options={ var options={
url : "http://codelanka.github.io/Presentation-Engines", url : "http://codelanka.github.io/Presentation-Engines",
hostname:"codelanka.github.io", hostname:"codelanka.github.io",
debug:false debug:false
} }
// detect from the url directly, library will make a request // detect from the url directly, library will make a request
@ -23,6 +31,7 @@ This is npm module for wappalyzer
}) })
// sample data
var data = { var data = {
url: options.url, url: options.url,
@ -43,60 +52,88 @@ This is npm module for wappalyzer
console.log(appInfo); console.log(appInfo);
}) })
```
### Output from QuickStart
```javascript
####Output // Apps
[
'CloudFlare',
null [ 'AngularJS',
'Font Awesome', 'Font Awesome',
'Google Font API', 'Google Maps',
'jQuery', 'Modernizr',
'Twitter Bootstrap' ] { AngularJS: 'Nginx',
{ app: 'AngularJS', 'RequireJS',
confidence: 'jQuery'
{ 'script //([\\d.]+(\\-?rc[.\\d]*)*)/angular(\\.min)?\\.js/i': 100, ]
'script /angular.*\\.js/i': 100 },
// Detailed info on links
{
CloudFlare: {
app: 'CloudFlare',
confidence: { 'headers Server /cloudflare/i': 100 },
confidenceTotal: 100,
detected: true,
excludes: [],
version: '',
versions: []
},
'Font Awesome': {
app: 'Font Awesome',
confidence: { 'html /<link[^>]* href=[^>]+font-awesome(?:\.min)?\.css/i': 100 },
confidenceTotal: 100, confidenceTotal: 100,
detected: true, detected: true,
excludes: [], excludes: [],
version: '1.3.5', version: '',
versions: [ '1.3.5' ] }, versions: []
'Font Awesome': },
{ app: 'Font Awesome', 'Google Maps': {
confidence: { 'html /<link[^>]* href=[^>]+font-awesome(?:\\.min)?\\.css/i': 100 }, app: 'Google Maps',
confidence: { 'script ///maps.googleapis.com/maps/api/js/i': 100 },
confidenceTotal: 100, confidenceTotal: 100,
detected: true, detected: true,
excludes: [], excludes: [],
version: '', version: '',
versions: [] }, versions: [] },
'Google Font API': 'Modernizr': {
{ app: 'Google Font API', app: 'Modernizr',
confidence: { 'html /<link[^>]* href=[^>]+fonts\\.(?:googleapis|google)\\.com/i': 100 }, confidence: { 'script /modernizr(?:-([\d.]*[\d]))?.*\.js/i': 100 },
confidenceTotal: 100,
detected: true,
excludes: [],
version: '2.6.2',
versions: [ '2.6.2' ] },
'Nginx': {
app: 'Nginx',
confidence: { 'headers Server /nginx(?:/([\d.]+))?/i': 100 },
confidenceTotal: 100, confidenceTotal: 100,
detected: true, detected: true,
excludes: [], excludes: [],
version: '', version: '',
versions: [] }, versions: [] },
jQuery: 'RequireJS': {
{ app: 'jQuery', app: 'RequireJS',
confidence: { 'script /jquery.*\\.js/i': 100 }, confidence: { 'script /require.*\.js/i': 100 },
confidenceTotal: 100, confidenceTotal: 100,
detected: true, detected: true,
excludes: [], excludes: [],
version: '', version: '',
versions: [] }, versions: [] },
'Twitter Bootstrap': 'jQuery': {
{ app: 'Twitter Bootstrap', app: 'jQuery',
confidence: confidence:
{ 'script /(?:twitter\\.github\\.com/bootstrap|bootstrap(?:\\.js|\\.min\\.js))/i': 100, { 'script //([\d.]+)/jquery(\.min)?\.js/i': 100,
'html /<link.+?href="[^"]+bootstrap(?:\\.min)?\\.css/i': 100 }, 'script /jquery.*\.js/i': 100 },
confidenceTotal: 100, confidenceTotal: 100,
detected: true, detected: true,
excludes: [], excludes: [],
version: '', version: '1.10.1',
versions: [] } } versions: [ '1.10.1' ]
}
}
```
## Credits
Wappalyzer Author - Elbert Alias Wappalyzer Author - Elbert Alias
@ -115,8 +152,12 @@ Refer to the [wiki](https://github.com/AliasIO/Wappalyzer/wiki) for
[contribute](https://github.com/AliasIO/Wappalyzer/wiki/Contributing) and [contribute](https://github.com/AliasIO/Wappalyzer/wiki/Contributing) and
[more](https://github.com/AliasIO/Wappalyzer/wiki/_pages). [more](https://github.com/AliasIO/Wappalyzer/wiki/_pages).
## License
*Licensed under the [GPL](https://github.com/AliasIO/Wappalyzer/blob/master/LICENSE).* *Licensed under the [GPL](https://github.com/AliasIO/Wappalyzer/blob/master/LICENSE).*
## Donations
Donate Bitcoin: 16gb4uGDAjaeRJwKVmKr2EXa8x2fmvT8EQ - *Thanks!* Donate Bitcoin: 16gb4uGDAjaeRJwKVmKr2EXa8x2fmvT8EQ - *Thanks!*
![QR Code](https://wappalyzer.com/sites/default/themes/wappalyzer/images/bitcoinqrcode.png) ![QR Code](https://wappalyzer.com/sites/default/themes/wappalyzer/images/bitcoinqrcode.png)