Update README

main
Elbert Alias 5 years ago
parent d1a636c7d6
commit adeb81dbd3

@ -1,18 +1,37 @@
# Wappalyzer [![Travis](https://travis-ci.org/aliasio/wappalyzer.svg?branch=master)](https://travis-ci.org/aliasio/wappalyzer/)
[Wappalyzer](https://www.wappalyzer.com/) is a
[cross-platform](https://www.wappalyzer.com/nodejs) utility that uncovers the
technologies used on websites. It detects
[content management systems](https://www.wappalyzer.com/technologies/cms),
[eCommerce platforms](https://www.wappalyzer.com/technologies/ecommerce),
[web servers](https://www.wappalyzer.com/technologies/web-servers),
[JavaScript frameworks](https://www.wappalyzer.com/technologies/javascript-frameworks),
[analytics tools](https://www.wappalyzer.com/technologies/analytics) and
[many more](https://www.wappalyzer.com/applications).
[Wappalyzer](https://www.wappalyzer.com) identifies technologies on websites.
*Licensed under [MIT](https://github.com/aliasio/wappalyzer/blob/master/LICENSE).*
## Documentation
Please read the [developer documentation](https://www.wappalyzer.com/docs).
## Documentation
## Quick start
```sh
git clone https://github.com/aliasio/wappalyzer
cd wappalyzer
yarn install
yarn link
```
## Usage
### Command line
```sh
node src/drivers/npm/cli.js https://example.com
```
### Chrome extension
* Go go `about:extensions`
* Enable 'Developer mode'
* Click 'Load unpacked'
* Select `src/drivers/webextension`
### Firefox extension
Please read the [developer documentation](https://www.wappalyzer.com/docs) to get started.
* Go go `about:debugging#/runtime/this-firefox`
* Click 'Load Temporary Add-on'
* Select `src/drivers/webextension/manifest.json`

@ -22,6 +22,7 @@ ADD cli.js .
ADD driver.js .
ADD package.json .
ADD wappalyzer.js .
ADD yarn.lock .
RUN yarn install

@ -1,25 +0,0 @@
#!/usr/bin/env node
const fs = require('fs')
const Wappalyzer = require('./wappalyzer')
// See https://www.wappalyzer.com/docs/dev/specification
const { apps: technologies, categories } = JSON.parse(
fs.readFileSync('./apps.json')
)
Wappalyzer.setTechnologies(technologies)
Wappalyzer.setCategories(categories)
const detections = Wappalyzer.analyze({
url: 'https://example.github.io/',
meta: { generator: ['WordPress'] },
headers: { server: ['Nginx'] },
scripts: ['jquery-3.0.0.js'],
cookies: { awselb: [''] },
html: '<div ng-app="">'
})
const results = Wappalyzer.resolve(detections)
console.log(results)