.gitattributes

@@ -1,3 +1,2 @@
-* text=auto
+* text=auto eol=lf
 *.ai binary
-*.js text eol=lf

.github/ISSUE_TEMPLATE/1-bug-report.md

@@ -0,0 +1,38 @@
+---
+name: "🐞 Bug report"
+about: Something is not working as it should
+---
+
+#### Describe the bug
+
+ - Node.js version: 
+ - OS & version: 
+
+<!-- A clear and concise description of what the bug is. -->
+
+#### Actual behavior
+
+...
+
+#### Expected behavior
+
+...
+
+#### Code to reproduce
+
+```js
+...
+```
+
+<!--
+We encourage you to submit a pull request with a failing test:
+ - This will make it more likely for us to prioritize your issue.
+ - It's a good way to prove that the issue is related to Got and not your code. 
+
+Example: https://github.com/avajs/ava/blob/master/docs/01-writing-tests.md#failing-tests
+-->
+
+#### Checklist
+
+- [ ] I have read the documentation.
+- [ ] I have tried my code with the latest version of Node.js and Got.

.github/ISSUE_TEMPLATE/2-feature-request.md

@@ -0,0 +1,18 @@
+---
+name: "⭐ Feature request"
+about: Suggest an idea for Got
+---
+
+#### What problem are you trying to solve?
+
+...
+
+#### Describe the feature
+
+...
+
+<!-- Include a usage example of the feature. If the feature is currently possible with a workaround, include that too. -->
+
+#### Checklist
+
+- [ ] I have read the documentation and made sure this feature doesn't already exist.

.github/ISSUE_TEMPLATE/3-question.md

@@ -0,0 +1,12 @@
+---
+name: "❓ Question"
+about: Something is unclear or needs to be discussed
+---
+
+#### What would you like to discuss?
+
+...
+
+#### Checklist
+
+- [ ] I have read the documentation.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+#### Checklist
+
+- [ ] I have read the documentation.
+- [ ] I have included a pull request description of my changes.
+- [ ] I have included some tests.
+- [ ] If it's a new feature, I have included documentation updates.

.travis.yml

@@ -1,7 +1,6 @@
-sudo: false
 language: node_js
 node_js:
+  - '10'
   - '8'
-  - '6'
-  - '4'
-after_success: npm run coveralls
+after_success:
+  - './node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls'

advanced-creation.md

@@ -0,0 +1,266 @@
+# Advanced creation
+
+> Make calling REST APIs easier by creating niche-specific `got` instances.
+
+#### got.create(settings)
+
+Example: [gh-got](https://github.com/sindresorhus/gh-got/blob/master/index.js)
+
+Configure a new `got` instance with the provided settings. You can access the resolved options with the `.defaults` property on the instance.
+
+**Note:** In contrast to `got.extend()`, this method has no defaults.
+
+##### [options](readme.md#options)
+
+To inherit from parent, set it as `got.defaults.options` or use [`got.mergeOptions(defaults.options, options)`](readme.md#gotmergeoptionsparentoptions-newoptions).<br>
+**Note**: Avoid using [object spread](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#Spread_in_object_literals) as it doesn't work recursively.
+
+##### mutableDefaults
+
+Type: `boolean`<br>
+Default: `false`
+
+States if the defaults are mutable. It's very useful when you need to [update headers over time](readme.md#hooksafterresponse).
+
+##### handler
+
+Type: `Function`<br>
+Default: `undefined`
+
+A function making additional changes to the request.
+
+To inherit from parent, set it as `got.defaults.handler`.<br>
+To use the default handler, just omit specifying this.
+
+###### [options](readme.md#options)
+
+**Note:** These options are [normalized](source/normalize-arguments.js).
+
+###### next()
+
+Returns a `Promise` or a `Stream` depending on [`options.stream`](readme.md#stream).
+
+```js
+const settings = {
+	handler: (options, next) => {
+		if (options.stream) {
+			// It's a Stream
+			// We can perform stream-specific actions on it
+			return next(options)
+				.on('request', request => setTimeout(() => request.abort(), 50));
+		}
+
+		// It's a Promise
+		return next(options);
+	},
+	options: got.mergeOptions(got.defaults.options, {
+		json: true
+	})
+};
+
+const jsonGot = got.create(settings);
+```
+
+```js
+const defaults = {
+	options: {
+		retry: {
+			retries: 2,
+			methods: [
+				'GET',
+				'PUT',
+				'HEAD',
+				'DELETE',
+				'OPTIONS',
+				'TRACE'
+			],
+			statusCodes: [
+				408,
+				413,
+				429,
+				500,
+				502,
+				503,
+				504
+			],
+			errorCodes: [
+				'ETIMEDOUT',
+				'ECONNRESET',
+				'EADDRINUSE',
+				'ECONNREFUSED',
+				'EPIPE',
+				'ENOTFOUND',
+				'ENETUNREACH',
+				'EAI_AGAIN'
+			]
+		},
+		headers: {
+			'user-agent': `${pkg.name}/${pkg.version} (https://github.com/sindresorhus/got)`
+		},
+		hooks: {
+			beforeRequest: [],
+			beforeRedirect: [],
+			beforeRetry: [],
+			afterResponse: []
+		},
+		decompress: true,
+		throwHttpErrors: true,
+		followRedirect: true,
+		stream: false,
+		form: false,
+		json: false,
+		cache: false,
+		useElectronNet: false
+	},
+	mutableDefaults: false
+};
+
+// Same as:
+const defaults = {
+	handler: got.defaults.handler,
+	options: got.defaults.options,
+	mutableDefaults: got.defaults.mutableDefaults
+};
+
+const unchangedGot = got.create(defaults);
+```
+
+```js
+const settings = {
+	handler: got.defaults.handler,
+	options: got.mergeOptions(got.defaults.options, {
+		headers: {
+			unicorn: 'rainbow'
+		}
+	})
+};
+
+const unicorn = got.create(settings);
+
+// Same as:
+const unicorn = got.extend({headers: {unicorn: 'rainbow'}});
+```
+
+### Merging instances
+
+Got supports composing multiple instances together. This is very powerful. You can create a client that limits download speed and then compose it with an instance that signs a request. It's like plugins without any of the plugin mess. You just create instances and then compose them together.
+
+#### got.mergeInstances(instanceA, instanceB, ...)
+
+Merges many instances into a single one:
+- options are merged using [`got.mergeOptions()`](readme.md#gotmergeoptionsparentoptions-newoptions) (+ hooks are merged too),
+- handlers are stored in an array.
+
+## Examples
+
+Some examples of what kind of instances you could compose together:
+
+#### Denying redirects that lead to other sites than specified
+
+```js
+const controlRedirects = got.create({
+	options: got.defaults.options,
+	handler: (options, next) => {
+		const promiseOrStream = next(options);
+		return promiseOrStream.on('redirect', resp => {
+			const host = new URL(resp.url).host;
+			if (options.allowedHosts && !options.allowedHosts.includes(host)) {
+				promiseOrStream.cancel(`Redirection to ${host} is not allowed`);
+			}
+		});
+	}
+});
+```
+
+#### Limiting download & upload
+
+It's very useful in case your machine's got a little amount of RAM.
+
+```js
+const limitDownloadUpload = got.create({
+    options: got.defaults.options,
+    handler: (options, next) => {
+        let promiseOrStream = next(options);
+        if (typeof options.downloadLimit === 'number') {
+            promiseOrStream.on('downloadProgress', progress => {
+        		if (progress.transferred > options.downloadLimit && progress.percent !== 1) {
+        			promiseOrStream.cancel(`Exceeded the download limit of ${options.downloadLimit} bytes`);
+        		}
+        	});
+        }
+
+        if (typeof options.uploadLimit === 'number') {
+            promiseOrStream.on('uploadProgress', progress => {
+        		if (progress.transferred > options.uploadLimit && progress.percent !== 1) {
+        			promiseOrStream.cancel(`Exceeded the upload limit of ${options.uploadLimit} bytes`);
+        		}
+        	});
+        }
+
+        return promiseOrStream;
+    }
+});
+```
+
+#### No user agent
+
+```js
+const noUserAgent = got.extend({
+	headers: {
+		'user-agent': null
+	}
+});
+```
+
+#### Custom endpoint
+
+```js
+const httpbin = got.extend({
+	baseUrl: 'https://httpbin.org/'
+});
+```
+
+#### Signing requests
+
+```js
+const crypto = require('crypto');
+const getMessageSignature = (data, secret) => crypto.createHmac('sha256', secret).update(data).digest('hex').toUpperCase();
+const signRequest = got.extend({
+	hooks: {
+		beforeRequest: [
+			options => {
+				options.headers['sign'] = getMessageSignature(options.body || '', process.env.SECRET);
+			}
+		]
+	}
+});
+```
+
+#### Putting it all together
+
+If these instances are different modules and you don't want to rewrite them, use `got.mergeInstances()`.
+
+**Note**: The `noUserAgent` instance must be placed at the end of chain as the instances are merged in order. Other instances do have the `user-agent` header.
+
+```js
+const merged = got.mergeInstances(controlRedirects, limitDownloadUpload, httpbin, signRequest, noUserAgent);
+
+(async () => {
+	// There's no 'user-agent' header :)
+	await merged('/');
+	/* HTTP Request =>
+	 * GET / HTTP/1.1
+	 * accept-encoding: gzip, deflate
+	 * sign: F9E66E179B6747AE54108F82F8ADE8B3C25D76FD30AFDE6C395822C530196169
+	 * Host: httpbin.org
+	 * Connection: close
+	 */
+
+	const MEGABYTE = 1048576;
+	await merged('http://ipv4.download.thinkbroadband.com/5MB.zip', {downloadLimit: MEGABYTE});
+	// CancelError: Exceeded the download limit of 1048576 bytes
+
+	await merged('https://jigsaw.w3.org/HTTP/300/301.html', {allowedHosts: ['google.com']});
+	// CancelError: Redirection to jigsaw.w3.org is not allowed
+})();
+```