diff --git a/README.md b/README.md index 5cd7934..9c87ef2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # riptide -quick, recursive, sitemap extractor \ No newline at end of file +quick, recursive, sitemap url extractor + +## installation and usage: + +``git clone https://codeberg.org/gigirassy/riptide/ && cd riptide && cargo install .`` + +```bash +riptide \ + --sitemap https://example.com/sitemap.xml \ + --output examplecomurls.txt \ + --scheme https \ + --workers 16 \ + --user-agent "Mozilla/5.0 (X11; Linux i686; rv:151.0) Gecko/20100101 Firefox/151.0" +``` + +by default, riptide identifies itself in user agent, the above example overrides it. + +## license + +isc \ No newline at end of file