Skip to content

Commit d793889

Browse files
committed
Updating docs 📝
1 parent 20281d5 commit d793889

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Git revision webpack plugin
22

3-
[![Build Status](https://travis-ci.org/pirelenito/git-revision-webpack-plugin.svg)](https://travis-ci.org/pirelenito/git-revision-webpack-plugin)
43
[![npm version](https://badge.fury.io/js/git-revision-webpack-plugin.svg)](https://badge.fury.io/js/git-revision-webpack-plugin)
54
[![downloads](https://img.shields.io/npm/dm/git-revision-webpack-plugin.svg?style=flat-square)](https://www.npmjs.com/package/git-revision-webpack-plugin)
6-
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
75
[![Code Climate](https://codeclimate.com/github/pirelenito/git-revision-webpack-plugin/badges/gpa.svg)](https://codeclimate.com/github/pirelenito/git-revision-webpack-plugin)
86

97
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.
108

119
## Usage
1210

13-
Given a **webpack 4** project ([check below](#outdated-webpack) for **old webpack versions**), install it as a local development dependency:
11+
Given a **webpack 5** project ([check below](#outdated-webpack) for **old webpack versions**), install it as a local development dependency:
1412

1513
```bash
1614
npm install --save-dev git-revision-webpack-plugin
@@ -198,7 +196,15 @@ module.exports = {
198196

199197
## Outdated webpack
200198

201-
If your project is **not using webpack version 4 or greater**, you will need to install an older version of this package:
199+
If your project is not running on Webpack 5, you will need older versions of this package.
200+
201+
### Webpack 4
202+
203+
```
204+
npm install git-revision-webpack-plugin@3.0.6
205+
```
206+
207+
### Webpack 3 or older
202208

203209
```
204210
npm install git-revision-webpack-plugin@2.5.1

0 commit comments

Comments
 (0)