Skip to content

Commit

Permalink
adds v2.x.x migration guide reference in README for findability
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsromero committed Jul 4, 2020
1 parent afa52a8 commit b926341
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
= Asciidoctor Maven Plugin changelog
:uri-asciidoctor: http://asciidoctor.org
:uri-asciidoc: {uri-asciidoctor}/docs/what-is-asciidoc
:uri-repo: https://github.com/asciidoctor/asciidoctor-maven-plugin
:icons: font
:star: icon:star[role=red]
ifndef::icons[]
:star: ★
endif::[]

This document provides a high-level view of the changes introduced on Asciidoctor Maven Plugin by release.
For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.

== Unreleased

* Add reference to v2-migration-guide in README for better findability
6 changes: 6 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ endif::[]

=== Setup

[WARNING]
====
2.0.0 version introduced breaking changes.
If you are upgrading from a previous version, please read the <<v2-migration-guide.adoc#,v2 migration guide>>.
====

As this is a typical Maven plugin, simply declare the plugin in the `<plugins>` section of your POM file:

[source,xml,subs=attributes+]
Expand Down

0 comments on commit b926341

Please sign in to comment.