Skip to content

Commit

Permalink
Changed README
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesRabauer committed Jan 29, 2024
1 parent c76eb8f commit 2f08c60
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
14 changes: 6 additions & 8 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,12 @@ jobs:
## [Changelog](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }})
See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information.
## Installation
Add the following lines to your pom:
```XML
<dependency>
<groupId>software.xdev</groupId>
<artifactId>${{ env.PRIMARY_MAVEN_MODULE }}</artifactId>
<version>${{ steps.version.outputs.release }}</version>
</dependency>
## Usage
Execute the following maven command in the maven project that you want to migrate:
```
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=software.xdev:${{ env.PRIMARY_MAVEN_MODULE }}:${{ steps.version.outputs.release }} \
-Drewrite.activeRecipes=software.xdev.spring.data.eclipse.store.JpaMigration
```
publish_central: # Publish the code to central
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 1.0.0

* Initial release
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,22 @@

# spring-data-eclipse-store-migration

Migrates your Spring-Data-JPA-project
to [Spring-Data-Eclipse-Store](https://github.com/xdev-software/spring-data-eclipse-store)
through a [OpenRewrite](https://docs.openrewrite.org/)-Recipe.

## Usage

```
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=software.xdev:spring-data-eclipse-store-migration:1.0.0-SNAPSHOT \
-Drewrite.activeRecipes=software.xdev.spring.data.eclipse.store.JpaMigration
```
[Usage guide for the latest release](https://github.com/xdev-software/spring-data-eclipse-store-migration/releases/latest#Usage

> [!CAUTION]
> Since Spring-Data-Eclipse-Store can't handle ```@Query```-Annotations,
> these annotations are getting removed by the Rewrite-Recipe.
## Support
If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).

If you need support as soon as possible, and you can't wait for any pull request, feel free to
use [our support](https://xdev.software/en/services/support).

## Contributing
See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
Expand Down

0 comments on commit 2f08c60

Please sign in to comment.