Skip to content

Commit 56fa03d

Browse files
Updated the ReadMe with new features
1 parent 3d7969f commit 56fa03d

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

readme.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313

1414
#### Automate your release process with a single command that can:
1515

16-
* Bump the version number of JSON manifets, including:
16+
* Optionally prompt for the type of version bump (major, minor, revision, beta, etc.)
17+
* Bump the version number in all of your JSON manifets, including:
1718
- `package.json`
1819
- `bower.json`
1920
- `component.json`
@@ -22,18 +23,23 @@
2223
- source code
2324
- README files
2425
- license files
26+
* Run your `preversion`, `version`, and `postversion` scripts
2527
* Commit changes to GIT
2628
* Tag the commit with the version number
2729
* Push the commit to remote
28-
* Optionally prompt for the type of version bump (major, minor, revision, beta, etc.)
2930

3031

31-
## Install
32+
Installation
33+
--------------------------
34+
You can install `version-bump-prompt` via [npm](https://docs.npmjs.com/getting-started/what-is-npm).
3235

33-
npm install -g version-bump-prompt
36+
```bash
37+
npm install -g version-bump-prompt
38+
```
3439

3540

36-
## Usage
41+
Usage
42+
--------------------------
3743

3844
```bash
3945
Usage: bump [options]
@@ -66,6 +72,15 @@ Examples:
6672
```
6773

6874

75+
Version Scripts
76+
--------------------------
77+
`version-bump-prompt` will execute your `preversion`, `version`, and `postversion` scripts, just like [the `npm version` command](https://docs.npmjs.com/cli/version) does. If your `package.json` file contains any or all of these scripts, then they will be executed in the following order:
78+
79+
- The `preversion` script runs before the version is updated (and before the version prompt is shown)
80+
- The `version` script runs after the version is updated, but _before_ `git commit` and `git tag`
81+
- The `postversion` script runs after `git commit` and `git tag`, but _before_ `git push`
82+
83+
6984

7085
Contributing
7186
--------------------------
@@ -85,7 +100,7 @@ To build the project locally on your computer:
85100

86101

87102

88-
## License
89-
103+
License
104+
--------------------------
90105
Version-Bump-Prompt is a fork of [Version-Bump](https://github.com/alexeyraspopov/node-bump) by Alexey Raspopov (c).
91106
Both the original project and this fork are licensed under the [MIT License](http://en.wikipedia.org/wiki/MIT_License)

0 commit comments

Comments
 (0)