Skip to content

Commit

Permalink
Chore: prepare 4.0.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
evilebottnawi committed Nov 15, 2017
1 parent f998986 commit d234d54
Show file tree
Hide file tree
Showing 5 changed files with 439 additions and 742 deletions.
23 changes: 14 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,37 @@ All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](http://semver.org).

## 4.0.0 - 2017-11-15

* Chore **Breaking Changes**: minimum required `generate-robotstxt` version is
now `^5.0.0`.

## 3.0.2 - 2017-10-10

- Chore: republish new version, because old was break.
* Chore: republish new version, because old was break.

## 3.0.1 - 2017-10-10

- Chore: republish new version, because old was break.
* Chore: republish new version, because old was break.

## 3.0.0 - 2017-10-09

- Changed: rename from `dest` to `filePath`.
- Changed: `dest` should contain file name (example - `/path/to/robots.txt`).
* Changed: rename from `dest` to `filePath`.
* Changed: `dest` should contain file name (example - `/path/to/robots.txt`).

## 2.0.0 - 2017-06-20

- Chore: support `webpack` v3.
- Changed: minimum require `nodejs` version is now `4.3`.
* Chore: support `webpack` v3.
* Changed: minimum require `nodejs` version is now `4.3`.

## 1.0.1 - 2017-02-01

- Fixed: added `webpack` as peer dependencies.
* Fixed: added `webpack` as peer dependencies.

## 1.0.0 - 2016-11-11

- Documentation: improve `README.md`.
* Documentation: improve `README.md`.

## 1.0.0-alpha.1 - 2016-11-11

- Chore: initial public release.
* Chore: initial public release.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
[![devDependencies Status](https://david-dm.org/itgalaxy/robotstxt-webpack-plugin/dev-status.svg)](https://david-dm.org/itgalaxy/robotstxt-webpack-plugin?type=dev)
[![Greenkeeper badge](https://badges.greenkeeper.io/itgalaxy/robotstxt-webpack-plugin.svg)](https://greenkeeper.io)

Webpack plugin for [generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt/) package.
Generating `robots.txt` using webpack.
Why your need [robots.txt](https://support.google.com/webmasters/answer/6062608?hl=en)?
Webpack plugin for
[generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt/) package.
Generating `robots.txt` using webpack. Why your need
[robots.txt](https://support.google.com/webmasters/answer/6062608?hl=en)?

## Install

Expand All @@ -19,39 +20,38 @@ npm install --save-dev robotstxt-webpack-plugin
## Usage

```js
const RobotstxtPlugin = require('robotstxt-webpack-plugin').default;
const RobotstxtPlugin = require("robotstxt-webpack-plugin").default;

const options = {}; // see options below

module.exports = {
plugins: [
new RobotstxtPlugin(options)
]
}
plugins: [new RobotstxtPlugin(options)]
};
```

Or

```js
import RobotstxtPlugin from 'robotstxt-webpack-plugin';
import RobotstxtPlugin from "robotstxt-webpack-plugin";

const options = {}; // see options below

export default {
plugins: [
new RobotstxtPlugin(options)
]
plugins: [new RobotstxtPlugin(options)]
};
```

## Options

- `General options` - see [generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt) options.
- `filePath` - (optional) path for robots.txt (should be contain full path include `robots.txt` file name, example - `path/to/robots.txt`).
* `General options` - see
[generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt) options.
* `filePath` - (optional) path for robots.txt (should be contain full path
include `robots.txt` file name, example - `path/to/robots.txt`).

## Related

- [generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt) - api for this package.
* [generate-robotstxt](https://github.com/itgalaxy/generate-robotstxt) - api for
this package.

## Contribution

Expand Down
12 changes: 10 additions & 2 deletions lint-staged.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
"use strict";

module.exports = {
"*.{js,jsx}": ["prettier --list-different", "eslint", "git add"],
"*.{md,markdown,mdown,mkdn,mkd,mdwn,mkdown,ron}": ["remark -f -q", "git add"]
"*.{js,jsx}": [
"prettier --list-different",
"eslint --report-unused-disable-directives",
"git add"
],
"*.{md,markdown,mdown,mkdn,mkd,mdwn,mkdown,ron}": [
"prettier --list-different",
"remark -f -q",
"git add"
]
};

0 comments on commit d234d54

Please sign in to comment.