From 4d0c0817b7cd61a7c46308e7e52dd1fb787a6deb Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 3 Sep 2026 10:43:56 +0000 Subject: [PATCH] docs(readme): add navigable index and normalize section structure Add a Table of Contents with GitHub-style #anchor links after the intro and before Installation, nesting each Quickstart's sub-sections. Existing heading hierarchy was already consistent (one H1, ## sections, ### sub-sections); no prose or code examples were changed. Co-Authored-By: Claude Opus 4.8 (1M context) Claude-Session: https://claude.ai/code/session_015rnxtANUejeRhQcGcftzsu --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 934bcf2..d7f038a 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,27 @@ This package ships two clients: CSV of URLs in one call. Best for offline / bulk pipelines. _(Private beta — [contact support](mailto:support@zenrows.com) for access.)_ +## Table of Contents + +- [Installation](#installation) +- [Quickstart — synchronous scraping (`ZenRowsClient`)](#quickstart--synchronous-scraping-zenrowsclient) + - [Adaptive Stealth Mode](#adaptive-stealth-mode) + - [POST Requests](#post-requests) + - [PUT Requests](#put-requests) + - [Concurrency](#concurrency) + - [Extract](#extract) +- [Quickstart — Batch API (`ZenRowsBatchClient`)](#quickstart--batch-api-zenrowsbatchclient) + - [Extract in a batch](#extract-in-a-batch) + - [Upload URLs from a CSV](#upload-urls-from-a-csv) + - [Estimate cost before submitting](#estimate-cost-before-submitting) + - [Retry only the failed tasks](#retry-only-the-failed-tasks) + - [Download results](#download-results) + - [Act on an id without a GET](#act-on-an-id-without-a-get) + - [Scheduled jobs & webhooks](#scheduled-jobs--webhooks) + - [Error handling](#error-handling) +- [Contributing](#contributing) +- [License](#license) + ## Installation ```bash