Add some docs and deprecated typo

README.md

@@ -1,2 +1,48 @@
 # susceptor
 Library and utilities supporting rapid development and centralized management of common development practices.
+
+## Getting Started
+
+This section desribed how to integrate susceptor in your development workflow and where and
+how it can help you developing plugins.
+
+## Features
+
+This brievly describes the core features of this library. You can find further information
+in the correspondign sub directories.
+
+### Dependency Injection
+
+Implemented in [susceptor-dependency-injection](susceptor-dependency-injection).
+
+Susceptor defines [Google Guice](https://github.com/google/guice) as a dependency injection framework.
+
+### Persistence
+
+Implemented in [susceptor-persistence](susceptor-persistence).
+
+The persistence module introduces MongoDB as a database and uses [Morphia](https://morphia.dev/)
+as orm for MongoDB.
+
+For getting started you should take a look at the [PersistenceModule](susceptor-persistence/src/main/java/de/marmeladenoma/susceptor/persistence/inject/PersistenceModule.java).
+This module contains several bindings for bootstrapping your persistence layer with MongoDB. The usage is pretty straight forward:
+
+```java
+var config = PersistenceConfig.newBuilder()
+  .withMongoConnectionString("")
+  .withMongoUser("")
+  .withMongoPassword("")
+  .withMongoSource("")
+  .build();
+var injector = Guice.createInjector(PersistenceModule.create(config));
+```
+
+The injector prepares a MongoDB Client that can be easily used via the
+[DatastoreFactory](susceptor-persistence/src/main/java/de/marmeladenoma/susceptor/persistence/DatastoreFactory.java):
+
+```java
+var datastoreFactory = injector.getInstance(DatastoreFactory.class);
+datastoreFactory.createDatastore("test_database");
+```
+
+Ready, Steady, Go!

build.gradle

@@ -4,7 +4,7 @@ plugins {
 
 subprojects {
   group "de.marmeladenoma"
-  version "0.2.0"
+  version "0.2.1"
 
   apply plugin: 'java'
   apply plugin: 'checkstyle'

susceptor-persistence/src/main/java/de/marmeladenoma/susceptor/persistence/inject/PersistenceConfig.java

@@ -82,6 +82,7 @@ public static final class PersistenceConfigBuilder {
     private PersistenceConfigBuilder() {
     }
 
+    @Deprecated
     public PersistenceConfigBuilder withMongoConnectionStrong(
       String mongoConnectionString
     ) {
@@ -90,6 +91,14 @@ public PersistenceConfigBuilder withMongoConnectionStrong(
       return this;
     }
 
+    public PersistenceConfigBuilder withMongoConnectionString(
+      String mongoConnectionString
+    ) {
+      Preconditions.checkNotNull(mongoConnectionString);
+      this.mongoConnectionString = mongoConnectionString;
+      return this;
+    }
+
     public PersistenceConfigBuilder withMongoUser(String mongoUser) {
       Preconditions.checkNotNull(mongoUser);
       this.mongoUser = mongoUser;

susceptor-persistence/src/test/java/de/marmeladenoma/susceptor/persistence/DatastoreFactoryTest.java

@@ -0,0 +1,20 @@
+package de.marmeladenoma.susceptor.persistence;
+
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+import de.marmeladenoma.susceptor.persistence.inject.PersistenceConfig;
+import de.marmeladenoma.susceptor.persistence.inject.PersistenceModule;
+
+class DatastoreFactoryTest {
+  public static void main(String[] args) {
+    var config = PersistenceConfig.newBuilder()
+      .withMongoConnectionString("")
+      .withMongoUser("")
+      .withMongoPassword("")
+      .withMongoSource("")
+      .build();
+    var injector = Guice.createInjector(PersistenceModule.create(config));
+    var datastoreFactory = injector.getInstance(DatastoreFactory.class);
+    datastoreFactory.createDatastore("test_database");
+  }
+}