Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sagebind committed Jun 28, 2018
1 parent 5a4ea26 commit ba30098
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# gradle-versioning
A Gradle plugin for applying project version from Git tags.

[![Build Status](https://travis-ci.org/Widen/gradle-versioning.svg?branch=master)](https://travis-ci.org/Widen/gradle-versioning)

A Gradle plugin for applying project version from Git tags.

Made with :heart: by Widen.

[Plugin page](https://plugins.gradle.org/plugin/com.widen.versioning)

## Overview
This plugin moves your project version out of the `build.gradle` file, and instead uses Git tags as the canonical source of truth for version numbers. This makes it easier to maintain nice version numbers and eliminate "Bump version" commits.

Expand Down Expand Up @@ -52,3 +57,6 @@ Version numbers generated by this plugin _do_ follow the [Semantic Versioning 2.

## Releasing this plugin
This Gradle plugin uses the most recent version of itself to determine its next version, so preparing a new release of `gradle-versioning` is much like releasing a normal project using this plugin. Simply publish a new tag in the Git repository, and a build will be published to the Maven repository automatically.

## License
Available under the Apache-2.0 license. See [the license file](LICENSE) for details.

0 comments on commit ba30098

Please sign in to comment.