updated README to reflect the implemented changes

Author: dadrus

README.md

@@ -4,11 +4,13 @@
 
 ## Overview
 This project implements a Groovy DSL that can be used to populate a database using JPA entities. Its indented use is testing but it could be used in other scenarios as well.
-The DSL is implemented in Groovy but can be used from pure Java. Entities are modularly defined in separate .groovy files using the DSL syntax. Those entitiy definition files can then be loaded as needed using the `de.triology.blog.testdataloader.TestDataLoader`, which also provides access to loaded entities. Thus, the client code does not need to deal with any database or JPA specific concerns other than providing an initialized EntityManager.
+The DSL is implemented in Groovy but can be used from pure Java. Entities are modularly defined in separate .groovy files using the DSL syntax. Those entity definition files can then be loaded as needed using the `de.triology.blog.testdata.loader.TestDataLoader`, which also provides access to loaded entities. Thus, the client code does not need to deal with any database or JPA specific concerns other than providing an initialized EntityManager.
 
 This project was started while working on an article published in [Java aktuell](http://www.ijug.eu/java-aktuell/das-magazin.html) 03/2017: 
 [A Groovy DSL for the Creation of Test Data using JPA](https://www.triology.de/en/blog-entries/groovy-dsl-test-data).  
-The original article (🇩🇪) can be found here: [Eine Groovy-DSL zum Erzeugen von Testdaten über JPA](https://www.triology.de/wp-content/uploads/2017/09/Eine-Groovy-DSL-zum-Erzeugen-von-Testdaten-ueber-JPA.pdf). 
+The original article (🇩🇪) can be found here: [Eine Groovy-DSL zum Erzeugen von Testdaten über JPA](https://www.triology.de/wp-content/uploads/2017/09/Eine-Groovy-DSL-zum-Erzeugen-von-Testdaten-ueber-JPA.pdf).
+
+Please note that from version 1.x the implementation as described in the article referenced above has changed. For more information about the changes, please refer to the release notes of each [release](https://github.com/triologygmbh/test-data-loader/releases).
 
 ## Configuration
 You can use JitPack to configure the test-data-loader as a dependency in your project.<br/>
@@ -26,22 +28,21 @@ And the test-data-loader dependency:
 <dependency>
     <groupId>com.github.triologygmbh</groupId>
     <artifactId>test-data-loader</artifactId>
-    <version>0.2.1</version>
+    <version>${version.test-data-loader}</version>
 </dependency>
 ```
 Current version is [![](https://jitpack.io/v/triologygmbh/test-data-loader.svg)](https://jitpack.io/#triologygmbh/test-data-loader).<br/> 
 For further details and options refer to the [JitPack website](https://jitpack.io/#triologygmbh/test-data-loader).
 
 ## Usage
-An example entity definition can be found here: https://github.com/triologygmbh/test-data-loader/blob/master/src/test/resources/demo/testData.groovy
+An example entity definition Groovy script file can be found here: https://github.com/triologygmbh/test-data-loader/blob/master/src/test/resources/tests/itTestData.groovy
 
-And [`de.triology.blog.testdataloader.demo.Demo`](https://github.com/triologygmbh/test-data-loader/blob/master/src/test/java/de/triology/blog/testdataloader/demo/Demo.java) shows how to load that file. (Notice that `Demo` is a Java class.)
+The [`de.triology.blog.testdata.loader.TestDataLoaderIT`](https://github.com/triologygmbh/test-data-loader/blob/master/src/test/java/de/triology/blog/testdata/loader/TestDataLoaderIT.java) integration test shows how to load that file.
 
 ### Entity Definitions
-Use the following syntax in a separate .groovy file to define a `User` entity. The entitiy will be created, persisted and registered under the name "Peter" when the definition file is loaded. _**Note:** Entity definition files are expected to be UTF-8 encoded._
+Use the following syntax in a separate .groovy file to define a `User` entity. The entity will be created, persisted and registered under the name "Peter" when the definition file is loaded. _**Note:** Entity definition files are expected to be UTF-8 encoded._
 ```Groovy
-import static de.triology.blog.testdataloader.EntityBuilder.create
-import de.triology.blog.testdataloader.demo.User
+import de.triology.blog.testdata.loader.testentities.User
 
 create User, 'Peter', {
     id = 123
@@ -53,9 +54,8 @@ create User, 'Peter', {
 ```
 Create nested entities by simply nesting their definitions:
 ```Groovy
-import static de.triology.blog.testdataloader.EntityBuilder.create
-import de.triology.blog.testdataloader.demo.User
-import de.triology.blog.testdataloader.demo.Department
+import de.triology.blog.testdata.loader.testentities.User
+import de.triology.blog.testdata.loader.testentities.Department
 
 create User, 'Peter', {
     // ...
@@ -67,9 +67,8 @@ create User, 'Peter', {
 ```
 And reference previously created entities by their name like so: 
 ```Groovy
-import static de.triology.blog.testdataloader.EntityBuilder.create
-import de.triology.blog.testdataloader.demo.User
-import de.triology.blog.testdataloader.demo.Department
+import de.triology.blog.testdata.loader.testentities.User
+import de.triology.blog.testdata.loader.testentities.Department
 
 create User, 'Peter', {
     // ...
@@ -86,10 +85,9 @@ create User, 'Tinker', {
     department = lostBoys
 }
 ```
-Since entity definition files are just plain Groovy scripts you are free to use any control structures like loops and conditions, e.g.:
+Since entity definition files are just plain Groovy scripts, you are free to use any control structures, like loops and conditions, e.g.:
 ```Groovy
-import static de.triology.blog.testdataloader.EntityBuilder.create
-import de.triology.blog.testdataloader.demo.User
+import de.triology.blog.testdata.loader.testentities.User
 
 5.times { count ->
     create User, "user_$count", {
@@ -109,8 +107,8 @@ For now, we must work around this, by setting the field to `protected` or creati
 See [this issue](https://github.com/triologygmbh/test-data-loader/issues/7).
 
 ### Loading entity definitions
-Use the `de.triology.blog.testdataloader.TestDataLoader` to load entitiy definition files (from classpath or file system) and persist the defined entities. 
-The `TestDataLoader` requires a fully initialized, ready-to-use entitiy manager and can then be used to load entity definition files and access the persisted entities.
+Use the `de.triology.blog.testdata.loader.TestDataLoader` to load entity definition files (from classpath or file system) and persist the defined entities. 
+The `TestDataLoader` requires a fully initialized, ready-to-use `EntityManager` and can then be used to load entity definition files and access the persisted entities.
 ```Java
 EntityManager entityManager = // ... init EntityManager
 TestDataLoader testDataLoader = new TestDataLoader(entityManager);
@@ -124,7 +122,7 @@ assert "Bell".equals(tinker.getLastName());
 ```
 
 ### Clean up afterwards
-To reset the database as well as the TestDataLoader to a clean state after a test case simply call `testDataLoader.clear()`. That will delete all created entites from the database and from TestDataLoader's entity cache.
+To reset the database as well as the TestDataLoader to a clean state after a test case simply call `testDataLoader.clear()`. That will delete all created entities from the database and from TestDataLoader's entity cache.
 
 ## Tested with...
 
@@ -135,4 +133,4 @@ We have approved TestDataLoader in multiple projects and use cases including
 * Integration tests with arquillian, IBM WebSphere Liberty Profile and IBM DB2
 
 ## Contributions
-The test-data-loader has been derived and generalized from real world development projects but has yet to prove itself as standalone library. **Any feedback or contributions are highly welcome!**
+The test-data-loader has been derived and generalized from real world development projects but has yet to prove itself as stand-alone library. **Any feedback or contributions are highly welcome!**