Skip to content

Commit 028762d

Browse files
committed
Notice about Webpack version compatibility and updated documentation links
1 parent 92f4397 commit 028762d

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
77
[![Code Climate](https://codeclimate.com/github/pirelenito/git-revision-webpack-plugin/badges/gpa.svg)](https://codeclimate.com/github/pirelenito/git-revision-webpack-plugin)
88

9-
Simple [webpack](http://webpack.github.io/) plugin that generates `VERSION` and `COMMITHASH` files during build based on a local [git](http://www.git-scm.com/) repository.
9+
Simple [webpack](https://webpack.js.org/) plugin that generates `VERSION` and `COMMITHASH` files during build based on a local [git](http://www.git-scm.com/) repository.
1010

1111
## Usage
1212

13-
Given a webpack project, install it as a local development dependency:
13+
Given a **Webpack 4** project ([check bellow](#outdated-webpack) for **old Webpack versions**), install it as a local development dependency:
1414

1515
```bash
1616
npm install --save-dev git-revision-webpack-plugin
@@ -48,7 +48,7 @@ master
4848

4949
## Path Substitutions
5050

51-
It is also possible to use [path substituitions](http://webpack.github.io/docs/configuration.html#output-filename) on build to get the revision, version or branch as part of output paths.
51+
It is also possible to use [path substituitions](https://webpack.js.org/configuration/output/#output-filename) on build to get the revision, version or branch as part of output paths.
5252

5353
- `[git-revision-version]`
5454
- `[git-revision-hash]`
@@ -69,7 +69,7 @@ module.exports = {
6969

7070
The `VERSION`, `COMMITHASH` and `BRANCH` are also exposed through a public API.
7171

72-
Example using the [DefinePlugin](http://webpack.github.io/docs/list-of-plugins.html#defineplugin):
72+
Example using the [DefinePlugin](https://webpack.js.org/plugins/define-plugin/#usage):
7373

7474
```javascript
7575
var gitRevisionPlugin = new GitRevisionPlugin()
@@ -168,3 +168,13 @@ module.exports = {
168168
]
169169
}
170170
```
171+
172+
## Outdated Webpack
173+
174+
If your project is **not using Wepack version 4 or greater**, you will need to install an older version of this package:
175+
176+
```
177+
npm install [email protected]
178+
```
179+
180+
Check [issue 29](https://github.com/pirelenito/git-revision-webpack-plugin/issues/29) for more information.

0 commit comments

Comments
 (0)