feat: add default mapper and some doc

CHANGELOG.md

@@ -1,5 +1,6 @@
 Changelog
 ---
-
+### 1.1.0
+- add method to get a default configured mapper
 #### 1.0.0
 - first release

README.md

@@ -2,6 +2,30 @@
 
 A Json exporter to serializer deserialize jmonkey engine object using the existing interfaces
 
+## MAVEN/GRADLE
+
+Add this repository : https://dl.bintray.com/exratio/jme-tool
+
+Maven:  
+```xml
+<dependency>
+  <groupId>fr.exratio</groupId>
+  <artifactId>JME-JsonExporter</artifactId>
+  <version>1.1.0</version>
+  <type>pom</type>
+</dependency>
+```
+Gradle
+> implementation 'fr.exratio:JME-JsonExporter:1.1.0'
+
+
+## Quickstart example
+
+> ObjectMapper mapper = ObjectMapperHelper.defaultMapper();
+> mapper.writeValue(new File("savable.json"), new Box);
+
+> Box mybox = mapper.readValue(new File("savable.json"), Box.class);
+
 ## Default Configuration
 A default working ObjectMapper is provided via the ObjectMapperHelper class. It works out of the box for all Savable implementation declared
 in com.jme3 package.
@@ -28,7 +52,7 @@ Some example:
 
 ### Serialization
 
-First declare a jackson Serializer or use the default provided Serializer (SavableJsonSerializer.class)
+First declare a jackson Serializer or use the default provided Serializer (``SavableJsonSerializer.class)
 
 > public class SavableJsonSerializer extends JsonSerializer< Savable > {
 >

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>fr.exratio</groupId>
     <artifactId>JME-JsonExporter</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <distributionManagement>
         <repository>
             <id>bintray-exratio-jme-tool</id>

src/main/java/fr/exratio/jme/exporter/ObjectMapperHelper.java

@@ -24,6 +24,10 @@ public class ObjectMapperHelper {
 
   private ObjectMapperHelper() {}
 
+  public static ObjectMapper defaultMapper() {
+    return configure(null, null);
+  }
+
   /**
    * This method help to configure (or to create if the object mapper parameter provided is null) an
    * ObjectMapper that will serialize and deserialize savable and scenes out of the box.
@@ -36,6 +40,8 @@ private ObjectMapperHelper() {}
   public static ObjectMapper configure(
       ObjectMapper objectMapper, List<Class> polymorphClasses, String... acceptedPackages) {
     ObjectMapper result = objectMapper != null ? objectMapper : new ObjectMapper();
+
+    //Allow subtype of those classes to be serialize/deserialize
     Builder builder =
         BasicPolymorphicTypeValidator.builder()
             .allowIfSubType(Map.class)
@@ -50,11 +56,14 @@ public static ObjectMapper configure(
     PolymorphicTypeValidator ptv = builder.build();
 
     result.activateDefaultTyping(ptv);
+    //only serialize public field or public getter
     result.setVisibility(PropertyAccessor.GETTER, Visibility.PUBLIC_ONLY);
     result.setVisibility(PropertyAccessor.FIELD, Visibility.PUBLIC_ONLY);
 
+
     String[] scannedPackages = ArrayUtils.add(acceptedPackages, JME_SAVABLE_PACKAGE);
-    ;
+    //Scan packages to find Savable implementation and setup the SavableMixIn which define the
+    //way of encoding the class and the deserializer to use
     try (ScanResult scanResult =
         new ClassGraph().enableClassInfo().acceptPackages(scannedPackages).scan()) {
       ClassInfoList classes = scanResult.getClassesImplementing(Savable.class.getName());