Add readme

mp911de · mp911de · commit 887f5c00612f · 2018-04-16T11:18:09.000+02:00
diff --git a/readme.md b/readme.md
@@ -0,0 +1,28 @@
+# Reactive Spring Workshop
+
+This project is the skeleton (and solution) for the Reactive Spring workshop. The slides are available from https://mp911.de/reactive-spring.
+
+This workshop is designed to help you to learn easily the Reactive API provided by [Reactor Core 3.x](https://github.com/reactor/reactor-core/) and to discover Spring's Reactive features through a practical example.
+
+You will mostly need these 3 classes Javadoc:
+
+ - [Flux](http://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html)
+ - [Mono](http://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html)
+ - [StepVerifier](http://projectreactor.io/docs/test/release/api/reactor/test/StepVerifier.html)
+ 
+To do this workshop, you just have to:
+
+ - Have [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) and a Java IDE ([IntelliJ IDEA](https://www.jetbrains.com/idea/) for example) installed with Maven support
+ - Clone/[Download](https://github.com/mp911de/reactive-spring/archive/master.zip) this repository (or your fork)
+ - Import the project as a Maven one in your IDE
+ - Make sure that the language level is set to Java 8 in your IDE project settings
+ - Fix the TODO one by one in StepX test classes to make unit tests green
+ 
+Once you mastered the basics, you can continue with Spring WebFlux and Spring Data examples that explain reactive
+ programming models with web applications and NoSQL data access.
+
+The solution is available in the [`complete`](https://github.com/mp911de/reactive-spring/tree/complete) branch ([download](https://github.com/mp911de/reactive-spring/archive/complete.zip)) to compare, when you have finished, with what you have done.
+
+## License
+
+This code is licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
