Update README.md

2026-08-30 23:27:39 +00:00 · 2026-06-14 00:40:31 +02:00
parent 510c0f39a5
commit f286997a90
1 changed files with 20 additions and 1 deletions
@@ -1,3 +1,22 @@
 # riptide

-quick, recursive, sitemap extractor
+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