From adeb81dbd34975259ff515d834bb161fe2651e26 Mon Sep 17 00:00:00 2001 From: Elbert Alias <77259+AliasIO@users.noreply.github.com> Date: Sun, 14 Jun 2020 10:17:50 +1000 Subject: [PATCH] Update README --- README.md | 43 +++++++++++++++++++++++++++----------- src/drivers/npm/Dockerfile | 1 + src/drivers/npm/core.js | 25 ---------------------- 3 files changed, 32 insertions(+), 37 deletions(-) delete mode 100755 src/drivers/npm/core.js diff --git a/README.md b/README.md index eba9f05b7..f3d428a12 100644 --- a/README.md +++ b/README.md @@ -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` diff --git a/src/drivers/npm/Dockerfile b/src/drivers/npm/Dockerfile index 8a3e99b85..499e53158 100644 --- a/src/drivers/npm/Dockerfile +++ b/src/drivers/npm/Dockerfile @@ -22,6 +22,7 @@ ADD cli.js . ADD driver.js . ADD package.json . ADD wappalyzer.js . +ADD yarn.lock . RUN yarn install diff --git a/src/drivers/npm/core.js b/src/drivers/npm/core.js deleted file mode 100755 index 660fdd264..000000000 --- a/src/drivers/npm/core.js +++ /dev/null @@ -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: '
' -}) - -const results = Wappalyzer.resolve(detections) - -console.log(results)