diff --git a/README.md b/README.md index de12879..95964a4 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,6 @@

Spring Data Event

- -

- -

### Features @@ -20,7 +16,7 @@ More to come later... Stay tuned ! ### Prerequisites -This library has been currently tested on projects under SpringBoot on version 3.2.XX or later, using Hibernate as a JPA implementation. +This library has been currently tested on projects under SpringBoot on version 3.2.4 with Java 17 or later, using Hibernate as a JPA implementation. ### Installation @@ -31,21 +27,12 @@ You will have to add the dependency in your spring-boot-project com.sipios spring-data-event - 0.1.0-SNAPSHOT + 0.1.0 ``` ### Configuration -First, you have to import spring kafka in your project. Add the following dependency in your pom (if using maven) - -```xml - - org.springframework.kafka - spring-kafka - -``` - Set up your application properties file to make spring kafka work properly ```txt @@ -53,17 +40,7 @@ spring.kafka.bootstrap-servers=localhost:29092 ``` Then, you will have to enable the library so that it will be able to work properly. -You can create a configuration class like that - -```java -@Configuration -@EnableDataEvent -public class DataEventConfiguration { -} -``` - -Or just adding the `@EnableDataEvent` on any of your `@Configuration` class. - +You just add the `@EnableDataEvent` on any of your `@Configuration` class already existing on your project, or directly on the `@SpringBootApplication` class. ## Usage @@ -88,6 +65,12 @@ public class UserEntity { } ``` +By default, the topics on which the event will be sent are : +- For the creation : `entity_name.created` (for example : `userentity.created`) +- For the update : `entity_name.updated` (for example : `userentity.updated`) +- For the deletion : `entity_name.deleted` (for example : `userentity.deleted`) + + ## FAQs No FAQ at the moment