diff --git a/docs/index.md b/docs/index.md index e00123f..f89afa8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,19 @@ A command-line utility for taking automated screenshots of websites +**Quick start**: + +``` +pip install shot-scraper +shot-scraper install +shot-scraper https://github.com/simonw/shot-scraper -h 900 +``` +Produces this screenshot in a file called `github-com-simonw-shot-scraper.png`: + +A screenshot of the shot-scraper page on GitHub + +**Contents** + ```{toctree} --- maxdepth: 3