Skip to content

Commit

Permalink
docs: update readme and changelog before release
Browse files Browse the repository at this point in the history
  • Loading branch information
B4nan committed Jul 22, 2021
1 parent fa12f72 commit 26620b1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
2.0.0 / 2021/06/23
2.0.0 / 2021/07/22
====================
- **BREAKING**: Require Node.js >=15.10.0 because HTTP2 support on lower Node.js versions is very buggy.
- Fix various issues by refactoring from got handlers to hooks.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Got Scraping
Got Scraping is a small but powerful `got` extension that allows you to send browser-like requests with only a little configuration seamlessly and with a single function call. [Got](https://github.com/sindresorhus/got) is a widely used and powerful client that provides extensibility and customization. Sending browser-like requests is essential in the web scraping industry to blend in with the website traffic. You can read more about the mimics [here](#simulating-browser-like-requests). Because HTTP2 support in older versions of Node.js is buggy, we recommend using Node.js >=15.10.0
Got Scraping is a small but powerful `got` extension that allows you to send browser-like requests with only a little configuration seamlessly and with a single function call. [Got](https://github.com/sindresorhus/got) is a widely used and powerful client that provides extensibility and customization. Sending browser-like requests is essential in the web scraping industry to blend in with the website traffic. You can read more about the mimics [here](#simulating-browser-like-requests). Because HTTP2 support in older versions of Node.js is buggy, we require using Node.js >=15.10.0 in v2. For older node versions you can use v1.

## Motivation
With the increasing popularity of web scraping, it is becoming more important to blend in with the typical internet traffic. This package implements multiple mimics to make GET requests similar to browsers. Thanks to the included [`header-generator`](https://github.com/apify/header-generator) package, you can choose various browsers from different operating systems and devices. The `header-generator` package generates all the headers for you so that you can focus on the important stuff.
Expand Down Expand Up @@ -52,10 +52,10 @@ Got Scraping package makes using proxies with your requests ridiculously easy. I
The proxy type and proxy HTTP version is a type of connection to a proxy. The agents are supported connections from the proxy to the target, let's say, a website.
## Installation

We strongly recommend using Node 15.10+ because of HTTP2 and TLS cipher support we use to emulate the browser.
Node 15.10+ is required because of HTTP2 and TLS cipher support we use to emulate the browser.

```bash
$ npm install got-scraping
$ npm install got-scraping
```

## Examples
Expand Down Expand Up @@ -93,7 +93,7 @@ const response = await gotScraping({
});
```

You can check out how to override request headers using handlers in the original `got` repo under the [instances](https://github.com/sindresorhus/got#instances) section.
You can check out how to override request headers using handlers in the original `got` repo under the [instances](https://github.com/sindresorhus/got#instances) section.

### Customizing Header generator options

Expand All @@ -110,7 +110,7 @@ const response = await gotScraping({
],
devices: ['desktop'],
locales: ['de-DE', 'en-US'],
operatingSystems: ['windows', 'linux']
operatingSystems: ['windows', 'linux']
}
});
```
Expand Down

0 comments on commit 26620b1

Please sign in to comment.