diff --git a/README.md b/README.md index 9e29f85..c77c3c5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,41 @@ # Facebook event scraper -A simple facebook event scraper written with puppeteer +A simple facebook event scraper written with node using puppeteer. ## Introduction -Please note that terms and condition apply from facebook and this should only be -used if written consent is provided by facebook. However it will work without. +Please note that terms and conditions apply from Facebook and this script should +only be used if written consent is provided by Facebook. + +## Dependencies for local install + +```sh +bash +node > v10 +yarn > # tested with 1.22 +``` ## Usage +```sh +./scrape.sh --help +``` + +## Examples + +```sh +./scrape.sh --event 2469238006641468 +./scrape.sh --page PlanetRammstein +./scrape.sh --pages PlanetRammstein bandmaldio +``` + ### Alpine docker image is provided ```sh +rm -rf node_modules # If switching from a local install docker build --tag facebook-scraper . docker run \ + --rm \ -v "$(pwd):/app" \ --cap-add SYS_ADMIN \ facebook-scraper