Skip to content

Commit a994747

Browse files
committed
Improves the documentation 💅
1 parent f91bcbc commit a994747

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ Simple [webpack](http://webpack.github.io/) plugin that generates `VERSION` and
44

55
## Usage
66

7+
Given a webpack project, install it as a local development dependency:
8+
79
```bash
810
npm install --save-dev git-revision-webpack-plugin
911
```
1012

11-
Sample webpack config:
13+
Then, simply configure it as a plugin in the webpack config:
1214

1315
```javascript
1416
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -19,3 +21,15 @@ module.exports = {
1921
]
2022
}
2123
```
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

Comments
 (0)