diff --git a/README.md b/README.md index e7e16a9..2f27873 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ fullscrape ========== -A Full Website Scraper \ No newline at end of file +A Full Website Scraper + +Usage: +> fullscrape [-d=depth] [-x] + +Arguments: +> url: The url that you want to start the scrape at. +> out-dir: The output directory. If it doesn't exist, it will be created. +> d: The depth of the scrape. Defaults to no limit. +> x: Cross Domain scraping. This could get dangerous, the internet's a big place. + +Sometime I may add the ability for fullscrape to automatically make non-relative links relative. Because that seems useful.