generate-robotstxt/README.md

# generate-robotstxt

[![NPM version](https://img.shields.io/npm/v/generate-robotstxt.svg)](https://www.npmjs.org/package/generate-robotstxt) [![Travis Build Status](https://img.shields.io/travis/itgalaxy/generate-robotstxt/master.svg?label=build)](https://travis-ci.org/itgalaxy/generate-robotstxt) [![dependencies Status](https://david-dm.org/itgalaxy/generate-robotstxt/status.svg)](https://david-dm.org/itgalaxy/generate-robotstxt) [![devDependencies Status](https://david-dm.org/itgalaxy/generate-robotstxt/dev-status.svg)](https://david-dm.org/itgalaxy/generate-robotstxt?type=dev)

Awesome generator robots.txt.

## Installation

```shell
npm install generate-robotstxt
```

## Usage

```js
const robotstxt = require('generate-robotstxt')

// 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);
  });
```

## [Changelog](CHANGELOG.md)

## [License](LICENSE.md)