Skip to content

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.

Updated README.md, CHANGELOG.md and CONTRIBUTING.md

Jan Curn7fb86ccf1464
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c6c7f7337..83123bc67 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,8 @@
+xxx
+==================
+- Updated documentation and README, consolidated images.
+- Added CONTRIBUTING.md
+
0.8.8 / 2018-09-25
==================
- Updated documentation and README.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 095b7c6d2..ddf138e66 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,7 +9,7 @@ Please note we have a code of conduct, please follow it in all your interactions
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
-2. Update the README.md with details of changes to the interface, this includes new environment
+2. Update the README.md and CHANGELOG.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
diff --git a/README.md b/README.md
index 722ff5b18..28d3e0509 100644
--- a/README.md
+++ b/README.md
@@ -205,7 +205,7 @@ Apify.main(async () => {
When you run the example, you should see Apify SDK automating several Chrome browsers.
<p style="text-align:center" align="center">
- <img src="./docs/hello-world-browsers.gif?raw=true" width="600">
+ <img src="https://raw.githubusercontent.com/apifytech/apify-js/develop/docs/hello-world-browsers.gif?raw=true" width="600">
</p>
By default, Apify SDK stores data to
@@ -1055,13 +1055,13 @@ See <a href="https://pptr.dev/#?product=Puppeteer&version=v1.6.0&show=api-puppet
Once live view is enabled, you can open http://localhost:4321 and you will see a page like this:
<p style="text-align:center" align="center">
- <img src="./docs/puppeteer-live-view-dashboard.png?raw=true" width="600">
+ <img src="https://raw.githubusercontent.com/apifytech/apify-js/develop/docs/puppeteer-live-view-dashboard.png?raw=true" width="600">
</p>
Click on the magnifying glass icon to view page detail, showing page screenshot and raw HTML:
<p style="text-align:center" align="center">
- <img src="./docs/puppeteer-live-view-detail.png?raw=true" width="600">
+ <img src="https://raw.githubusercontent.com/apifytech/apify-js/develop/docs/puppeteer-live-view-detail.png?raw=true" width="600">
</p>
For more information, read the <a href="https://kb.apify.com/actor/debugging-your-actors-with-live-view" target="_blank">Debugging your actors with Live View</a>