Chore: prepare 4.0.1 release.

Author: Alexander Krasnoyarov

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Head
+# 4.0.1 - 2016-10-27
 
 - Chore: added support `nodejs` `7`.
 - Chore: update a minimal version of `npm-run-all` from `2.3.0` to `3.0.0`.
@@ -11,6 +11,7 @@
 - Chore: update a minimal version of `eslint-plugin-promise` from `2.0.0` to `3.0.0`. 
 - Chore: update a minimal version of `eslint-plugin-lodash` fro `1.10.0` to `2.1.0`.
 - Chore: update a minimal version of `eslint-plugin-import` from `1.14.0` to `2.0.0`.
+- Documentation: improve `README.md` and fix typos.
 
 # 4.0.0
 

README.md

@@ -22,7 +22,35 @@ npm install generate-robotstxt
 ```js
 const robotstxt = require('generate-robotstxt').default;
 
-// Pass in the absolute path to your robots.txt file
+robotstxt({
+    policy: [
+        {
+            userAgent: 'Googlebot',
+            allow: '/',
+            disallow: '/search',
+            crawlDelay: 2
+        },
+        {
+            userAgent: '*',
+            allow: '/',
+            disallow: '/search',
+            crawlDelay: 10,
+            cleanParam: 'ref /articles/'
+        }
+    ],
+    sitemap: 'sitemap.xml',
+    host: 'http://example.com'
+})
+  .then((content) => {
+    console.log(content);
+  });
+```
+
+Or
+
+```js
+import robotstxt from 'generate-robotstxt';
+
 robotstxt({
     policy: [
         {

package.json

@@ -1,6 +1,6 @@
 {
     "name": "generate-robotstxt",
-    "version": "4.0.0",
+    "version": "4.0.1",
     "description": "Awesome generator robots.txt",
     "author": "itgalaxy <[email protected]>",
     "contributors": [

src/standalone.js

@@ -16,6 +16,42 @@ function addLine(name, rule) {
     return contents;
 }
 
+function generatePoliceItem(item, index) {
+    if (!item.userAgent || (item.userAgent && item.userAgent.length === 0)) {
+        throw new Error('Each "police" should have "User-agent"');
+    }
+
+    let contents = '';
+
+    if (index !== 0) {
+        contents += '\n';
+    }
+
+    contents += addLine('User-agent', item.userAgent);
+
+    if (item.allow) {
+        contents += addLine('Allow', item.allow);
+    }
+
+    if (item.disallow) {
+        contents += addLine('Disallow', item.disallow);
+    }
+
+    if (item.crawlDelay && typeof item.crawlDelay !== 'number' && !isFinite(item.crawlDelay)) {
+        throw new Error('Options "crawlDelay" must be integer or float');
+    }
+
+    if (item.crawlDelay) {
+        contents += addLine('Crawl-delay', item.crawlDelay);
+    }
+
+    if (item.cleanParam) {
+        contents += addLine('Clean-param', item.cleanParam);
+    }
+
+    return contents;
+}
+
 export default function ({
     configFile = null,
     policy = [{
@@ -63,42 +99,9 @@ export default function ({
             }
 
             let contents = '';
-            let counter = 0;
-
-            options.policy.forEach((item) => {
-                if (!item.userAgent || (item.userAgent && item.userAgent.length === 0)) {
-                    return reject(new Error('Each "police" should have "User-agent"'));
-                }
-
-                contents += addLine('User-agent', item.userAgent);
-
-                if (item.allow) {
-                    contents += addLine('Allow', item.allow);
-                }
-
-                if (item.disallow) {
-                    contents += addLine('Disallow', item.disallow);
-                }
-
-                if (item.crawlDelay && typeof item.crawlDelay !== 'number' && !isFinite(item.crawlDelay)) {
-                    return reject(new Error('Options "crawlDelay" must be integer or float'));
-                }
-
-                if (item.crawlDelay) {
-                    contents += addLine('Crawl-delay', item.crawlDelay);
-                }
-
-                if (item.cleanParam) {
-                    contents += addLine('Clean-param', item.cleanParam);
-                }
-
-                counter++;
-
-                if (counter !== options.policy.length) {
-                    contents += '\n';
-                }
 
-                return item;
+            options.policy.forEach((item, index) => {
+                contents += generatePoliceItem(item, index);
             });
 
             if (options.sitemap) {