We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent f91bcbc commit a994747Copy full SHA for a994747
1 file changed
README.md
@@ -4,11 +4,13 @@ Simple [webpack](http://webpack.github.io/) plugin that generates `VERSION` and
4
5
## Usage
6
7
+Given a webpack project, install it as a local development dependency:
8
+
9
```bash
10
npm install --save-dev git-revision-webpack-plugin
11
```
12
-Sample webpack config:
13
+Then, simply configure it as a plugin in the webpack config:
14
15
```javascript
16
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -19,3 +21,15 @@ module.exports = {
19
21
]
20
22
}
23
24
25
+It outputs a `VERSION` based on [git-describe](http://www.git-scm.com/docs/git-describe) such as:
26
27
+```
28
+v0.0.0-34-g7c16d8b
29
30
31
+And a `COMMITHASH` such as:
32
33
34
+7c16d8b1abeced419c14eb9908baeb4229ac0542
35
0 commit comments