Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.
TypeScript apifyautomationcrawlercrawlingheadlessheadless-chromejavascriptnodejsnpmplaywrightpuppeteerscraperscrapingtypescriptweb-crawlerweb-crawlingweb-scraping
docs: remove old outdated readme snippets
Martin Adámek058d28d21f3c
diff --git a/docs/readme/introduction.md b/docs/readme/introduction.mddeleted file mode 100644index 958511129..000000000--- a/docs/readme/introduction.md+++ /dev/null@@ -1,18 +0,0 @@---------# Crawlee: The scalable web crawling and scraping library for JavaScript--<!-- Mirror this part to src/index.js -->--[](https://www.npmjs.com/package/crawlee)--Crawlee simplifies the development of web crawlers, scrapers, data extractors and web automation jobs.-It provides tools to manage and automatically scale a pool of headless browsers,-to maintain queues of URLs to crawl, store crawling results to a local filesystem or into the cloud,-rotate proxies and much more.-Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package.-It can be used either stand-alone in your own applications-or in [actors](https://docs.apify.com/actor)-running on the [Apify Cloud](https://apify.com/).--**View full documentation, guides and examples on the [Crawlee project website](https://sdk.apify.com)**diff --git a/docs/readme/overview.md b/docs/readme/overview.mddeleted file mode 100644index 2c7861045..000000000--- a/docs/readme/overview.md+++ /dev/null@@ -1,50 +0,0 @@---------## Overview--Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package and it provides the following tools:--- [`CheerioCrawler`](https://sdk.apify.com/docs/api/cheerio-crawler) - Enables the parallel crawling of a large- number of web pages using the [cheerio](https://www.npmjs.com/package/cheerio) HTML parser. This is the most- efficient web crawler, but it does not work on websites that require JavaScript.--- [`PuppeteerCrawler`](https://sdk.apify.com/docs/api/puppeteer-crawler) - Enables the parallel crawling of- a large number of web pages using the headless Chrome browser and [Puppeteer](https://github.com/puppeteer/puppeteer).- The pool of Chrome browsers is automatically scaled up and down based on available system resources.--- [`PlaywrightCrawler`](https://sdk.apify.com/docs/api/playwright-crawler) - Unlike `PuppeteerCrawler`- you can use [Playwright](https://github.com/microsoft/playwright) to manage almost any headless browser.- It also provides a cleaner and more mature interface while keeping the ease of use and advanced features.--- [`BasicCrawler`](https://sdk.apify.com/docs/api/basic-crawler) - Provides a simple framework for the parallel- crawling of web pages whose URLs are fed either from a static list or from a dynamic queue of URLs. This class- serves as a base for the more specialized crawlers above.--- [`RequestList`](https://sdk.apify.com/docs/api/request-list) - Represents a list of URLs to crawl.- The URLs can be passed in code or in a text file hosted on the web. The list persists its state so that crawling- can resume when the Node.js process restarts.--- [`RequestQueue`](https://sdk.apify.com/docs/api/request-queue) - Represents a queue of URLs to crawl,- which is stored either on a local filesystem or in the [Apify Cloud](https://apify.com). The queue is used- for deep crawling of websites, where you start with several URLs and then recursively follow links to other pages.- The data structure supports both breadth-first and depth-first crawling orders.--- [`Dataset`](https://sdk.apify.com/docs/api/dataset) - Provides a store for structured data and enables their export- to formats like JSON, JSONL, CSV, XML, Excel or HTML. The data is stored on a local filesystem or in the Apify Cloud.- Datasets are useful for storing and sharing large tabular crawling results, such as a list of products or real estate offers.--- [`KeyValueStore`](https://sdk.apify.com/docs/api/key-value-store) - A simple key-value store for arbitrary data- records or files, along with their MIME content type. It is ideal for saving screenshots of web pages, PDFs- or to persist the state of your crawlers. The data is stored on a local filesystem or in the Apify Cloud.--- [`AutoscaledPool`](https://sdk.apify.com/docs/api/autoscaled-pool) - Runs asynchronous background tasks,- while automatically adjusting the concurrency based on free system memory and CPU usage. This is useful for running- web scraping tasks at the maximum capacity of the system.--- [`Browser Utils`](https://sdk.apify.com/docs/api/puppeteer) - Provides several helper functions useful- for web scraping. For example, to inject jQuery into web pages or to hide browser origin.--Additionally, the package provides various helper functions to simplify running your code on the Apify Cloud and thus-take advantage of its pool of proxies, job scheduler, data storage, etc.-For more information, see the [Crawlee Programmer's Reference](https://sdk.apify.com).-diff --git a/docs/readme/support.md b/docs/readme/support.mddeleted file mode 100644index 3d7d60600..000000000--- a/docs/readme/support.md+++ /dev/null@@ -1,23 +0,0 @@---------## Support--If you find any bug or issue with Crawlee, please [submit an issue on GitHub](https://github.com/apify/apify-js/issues).-For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify) or contact [email protected]--## Contributing--Your code contributions are welcome and you'll be praised to eternity!-If you have any ideas for improvements, either submit an issue or create a pull request.-For contribution guidelines and the code of conduct,-see [CONTRIBUTING.md](https://github.com/apify/apify-js/blob/master/CONTRIBUTING.md).--## License--This project is licensed under the Apache License 2.0 --see the [LICENSE.md](https://github.com/apify/apify-js/blob/master/LICENSE.md) file for details.--## Acknowledgments--Many thanks to [Chema Balsas](https://www.npmjs.com/~jbalsas) for giving up the `apify` package name-on NPM and renaming his project to [jsdocify](https://www.npmjs.com/package/jsdocify).