summaryrefslogtreecommitdiff
path: root/docs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/readme.md')
-rw-r--r--docs/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 0000000..cb9eb5b
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,22 @@
+# Documentation
+
+#### Getting Started
+
+- [Installation](getting-started/installation.md)
+- [Running flyscrape](getting-started/running-flyscrape.md)
+
+#### Using flyscrape
+
+- [Scraping Setup](using-flyscrape/scraping-setup.md)
+- [Development Mode](using-flyscrape/development-mode.md)
+- [Start Scraping](using-flyscrape/start-scraping.md)
+
+#### Configuration
+- [Starting URL](config/starting-url.md)
+- [Depth](config/depth.md)
+- [Link Following](config/link-following.md)
+- [Domain Filter](config/domain-filter.md)
+- [URL Filter](config/url-filter.md)
+- [Rate Limiting](config/rate-limiting.md)
+- [Caching](config/caching.md)
+- [Proxies](config/proxies.md)