38 lines
1.2 KiB
Plaintext
38 lines
1.2 KiB
Plaintext
= Spring Rewrite Commons
|
|
:partials_dir: spring-rewrite-commons-docs/src/main/antora/modules/ROOT/pages/partials
|
|
:project-version: 0.1.0-SNAPSHOT
|
|
:projectVersion: {project-version}
|
|
:docs: https://docs.spring.io/spring-rewrite-commons/docs/current-SNAPSHOT/reference/html/
|
|
|
|
[quote]
|
|
____
|
|
Spring Rewrite Commons provides a set of components to parse a Java project to https://github.com/openrewrite[OpenRewrite,window=_blank] LST and apply recipes outside a build tool plugin.
|
|
____
|
|
|
|
|
|
== Get started
|
|
|
|
=== Add Dependency
|
|
|
|
**Maven**
|
|
include::{partials_dir}/maven-dependency-snippet.adoc[]
|
|
|
|
**Gradle**
|
|
include::{partials_dir}/gradle-dependency-snippet.adoc[]
|
|
|
|
=== Implement a Recipe Launcher
|
|
|
|
include::{partials_dir}/example-application-code.adoc[]
|
|
|
|
|
|
== Reference documentation
|
|
|
|
Find the reference documentation link:{docs}[here].
|
|
|
|
== Contributing
|
|
|
|
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome. Note, that we expect everyone to follow the https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[code of conduct].
|
|
|
|
== License
|
|
Spring Rewrite Commons is Open Source software released under the
|
|
https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license]. |