Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 1.65 KB

README.md

File metadata and controls

75 lines (46 loc) · 1.65 KB
Raw

Version Bumpify

Version License

A Node.js CLI tool to automatically update the version in package.json, package-lock.json, and the version badge in README.md.

Features

  • Automatically updates the version field in package.json and package-lock.json.
  • Updates the version badge in README.md (Shields.io style).
  • Simple CLI tool with easy integration into any Node.js project.

Installation

To install globally:

npm install -g version-bumpify

Usage

To update the version across package.json, package-lock.json, and the version badge in README.md:

bumpify <new_version>

Example:

bumpify 2.0.2

This command will:

  • Update package.json and package-lock.json to version 2.0.2.
  • Update the Shields.io version badge in README.md.

Example

Before running the command:

![Version](https://img.shields.io/badge/version-v1.0.2-blue.svg)

After running bump 2.0.2:

![Version](https://img.shields.io/badge/version-v2.0.2-blue.svg)

Running Tests

To run the test suite:

npm test

This will execute the test cases to ensure the functionality of the bumpify.

Contributing

Contributions are welcome! For detailed contribution guidelines, please refer to the CONTRIBUTING file.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Bugs and Issues

If you find any bugs or have issues, please report them via GitHub Issues.