From 89de884e34479f79a6a71808a539c59b97858891 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Mon, 2 Jul 2018 00:00:06 -0700 Subject: [PATCH] Cleanup. --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 33b6930..20a5069 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ A [Semantic Version](https://semver.org) Plugin for [Gradle](https://gradle.org) that manages a project version via a properties file, and provide tasks to __automatically increment__ major, minor and patch build numbers. -The plugin can be used in conjunction with the [Semantic Version Annotation Processor](https://github.com/ethauvin/semver). +The plugin can be used in conjunction with the [__Semantic Version Annotation Processor__](https://github.com/ethauvin/semver). ## Using the plugin -The plugin is published to the Plugin Portal; see instructions there: [net.thauvin.erik.gradle.semver](https://plugins.gradle.org/plugin/net.thauvin.erik.gradle.semver) +The plugin is published to the Plugin Portal; see instructions there: [__net.thauvin.erik.gradle.semver__](https://plugins.gradle.org/plugin/net.thauvin.erik.gradle.semver) ## Version Properties File @@ -25,6 +25,8 @@ version.buildmeta= To change the version of your project, remove the version from your `build.gradle` and simply edit your the version properties file to match your version number. +- __Examples__: [Java](https://github.com/ethauvin/semver-gradle/tree/master/examples/java), [Kotlin](https://github.com/ethauvin/semver-gradle/tree/master/examples/kotlin) + If you need to change the properties file or name of the properties keys to match your own build environment. Please see the [Configuration](#configuration) section. ## Increment Version Tasks @@ -49,6 +51,8 @@ someTask { } ``` +- __Examples__: [Java](https://github.com/ethauvin/semver-gradle/tree/master/examples/java), [Kotlin](https://github.com/ethauvin/semver-gradle/tree/master/examples/kotlin) + ## Configuration ### Version File Properties @@ -85,6 +89,8 @@ version.buildmeta=exp.sha.5114f85 `projet.version` will be `1.0.0-beta+exp.sha.5114f85` in Gradle. +- __Examples__: [Java](https://github.com/ethauvin/semver-gradle/tree/master/examples/java), [Kotlin](https://github.com/ethauvin/semver-gradle/tree/master/examples/kotlin) + ### Semver In a Gradle build file, the `semver` block is used to configure how the plugin will read/write the version properties file. In most cases it is not needed. @@ -153,6 +159,10 @@ test.prerelease= test.buildmeta= ``` +- __Examples__: [Java](https://github.com/ethauvin/semver-gradle/tree/master/examples/java), [Kotlin](https://github.com/ethauvin/semver-gradle/tree/master/examples/kotlin) + ## Source Code Generation -If you'd like to incorporate the version number data into your source code, please have a look at the [Semantic Version Annotation Processor](https://github.com/ethauvin/semver). \ No newline at end of file +If you'd like to incorporate the version number data into your source code, please have a look at the [__Semantic Version Annotation Processor__](https://github.com/ethauvin/semver). + +There are also full [examples](https://github.com/ethauvin/semver-gradle/tree/master/examples/annotation-processor) in both [Java](https://github.com/ethauvin/semver-gradle/tree/master/examples/annotation-processor/java) and [Kotlin](https://github.com/ethauvin/semver-gradle/tree/master/examples/annotation-processor) showing how to use both the plugin and annotation processor concurrently. \ No newline at end of file