Update readme

Author: ogesaku

README.md

@@ -13,45 +13,45 @@
 * [Basic usage](#basic-usage)
 * [Message formatting](#message-formatting)
 * [Message loading](#message-loading)
-  * [Manual messages creation](#manual-messages-creation)
-  * [Loading messages from classpath or file system](#loading-messages-from-classpath-or-file-system)
-  * [Single message file with multiple locales](#single-message-file-with-multiple-locales)
-  * [Watching for file changes](#watching-for-file-changes)
+    * [Manual messages creation](#manual-messages-creation)
+    * [Loading messages from classpath or file system](#loading-messages-from-classpath-or-file-system)
+    * [Single message file with multiple locales](#single-message-file-with-multiple-locales)
+    * [Watching for file changes](#watching-for-file-changes)
 * [Message resolution](#message-resolution)
-  * [Message fallbacks](#message-fallbacks)
-  * [Prefixed queries](#prefixed-queries)
-  * [Localized queries](#localized-queries)
+    * [Message fallbacks](#message-fallbacks)
+    * [Prefixed queries](#prefixed-queries)
+    * [Localized queries](#localized-queries)
 * [Message references](#message-references)
-  * [Reference resolution order](#reference-resolution-order)
-  * [References in a prefixed file](#references-in-a-prefixed-file)
+    * [Reference resolution order](#reference-resolution-order)
+    * [References in a prefixed file](#references-in-a-prefixed-file)
 * [Type based formatters](#type-based-formatters)
 * [Missing messages](#missing-messages)
-  * [Missing message handler](#missing-message-handler)
-  * [Missing message detection](#missing-message-detection)
+    * [Missing message handler](#missing-message-handler)
+    * [Missing message detection](#missing-message-detection)
 * [Whitespace normalization](#whitespace-normalization)
 * [DevMode](#devmode)
 
-
 ## Installation
 
 Add to your `build.gradle`:
 
 ```gradle
 dependencies {
-    implementation "com.coditory.quark:quark-i18n:0.0.8"
+    implementation "com.coditory.quark:quark-i18n:$version"
 }
 ```
 
 ## Basic usage
 
 ```java
 I18nMessagePack messagePack = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(Locales.EN_US)
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(Locales.EN_US)
+        .build();
 
 // ...when request arrives
 I18nMessages messages = messagePack.localize(req.getLocale());
+
 print(messages.getMessage("greeting", userName));
 ```
 
@@ -92,31 +92,33 @@ Messages can be created in 3 ways:
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .addMessage(Loacles.EN_US, "hello", "Hello {0}")
-    .addMessage(Loacles.PL_PL, "hello", "Cześć {0}")
-    .setDefaultLocale(PL_PL)
-    .build();
+        .addMessage(Loacles.EN_US, "hello", "Hello {0}")
+        .addMessage(Loacles.PL_PL, "hello", "Cześć {0}")
+        .setDefaultLocale(PL_PL)
+        .build();
 
-messages.getMessage(Loacles.EN_US, "hello", userName);
+messages.
+
+getMessage(Loacles.EN_US, "hello",userName);
 ```
 
 If you want to quickly load messages from a nested map (for example fetched from a document storage)
 you can use `I18nParsers.parseEntries(map, locale)` to translate nested the map keys into localized message paths.
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .addMessages(I18nParsers.parseEntries(Map.of("hello", "Hello {0}"), EN_US))
-    .build();
+        .addMessages(I18nParsers.parseEntries(Map.of("hello", "Hello {0}"), EN_US))
+        .build();
 ```
 
 ### Loading messages from classpath or file system
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .scanFileSystem("./overriddes/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .scanFileSystem("./overriddes/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .build();
 ```
 
 Localization based path placeholders are used to assign all messages in the file to file's locale.
@@ -147,6 +149,7 @@ When path pattern does not contain one of localization placeholders (`{locale}`,
 then locale is parsed from the last segment of the message path:
 
 Example in `yml`
+
 ```yml
 homepage.title:
   pl-PL: Strona główna
@@ -159,8 +162,12 @@ To reload messages in file change use:
 
 ```java
 I18nMessagePack.builder()
-    .scanFileSystem("i18n/*")
-    .buildAndWatchForChanges();
+    .
+
+scanFileSystem("i18n/*")
+    .
+
+buildAndWatchForChanges();
 ```
 
 ATM, it works for messages loaded from filesystem only, but for add your own implementation of `WatchableI18nLoader`.
@@ -173,10 +180,10 @@ If there is still no match then the default locale (followed by a less strict de
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .addFallbackKeyPrefix("glossary")
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .addFallbackKeyPrefix("glossary")
+        .build();
 
 String message = messages.getMessage(Locales.en_US, "hello");
 ```
@@ -194,10 +201,10 @@ Sometimes it is useful to specify a common path prefix for all unmatched queries
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .addMessageFallbackKeyPrefix("common")
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .addMessageFallbackKeyPrefix("common")
+        .build();
 
 String message = messages.getMessage(Locales.en_US, "hello");
 ```
@@ -217,9 +224,9 @@ Sometimes it's useful to prefix all queries with some path, like in the example:
 
 ```java
 I18nMessagePack messages = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .build();
 
 I18nMessagePack homepageMessages = messages.prefixQueries("pages.homepage");
 String homepageTitle = homepageMessages.getMessage(en_US, "title");
@@ -241,9 +248,9 @@ Sometimes it's useful to apply common locale to all queries:
 
 ```java
 I18nMessagePack messagePack = I18nMessagePack.builder()
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .build();
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .build();
 
 // ...when request arrives
 I18nMessages messages = messagePack.localize(req.getLocale());
@@ -255,15 +262,16 @@ Query localization mechanism can be used together with query prefixes:
 
 ```java
 I18nMessages messages = messagePack
-    .prefixQueries("pages.homepage")
-    .localize(req.getLocale());
+        .prefixQueries("pages.homepage")
+        .localize(req.getLocale());
 ```
 
 ## Message references
 
 Message references are the way to reuse text across multiple messages.
 
 Example in yml:
+
 ```yml
 # Common entries
 company:
@@ -274,7 +282,7 @@ about-company: "${company.name} was established on ${company.established}"
 ```
 
 ```java
-messages.getMessage("about-company") == "ACME was established on 1988"
+messages.getMessage("about-company") =="ACME was established on 1988"
 ```
 
 - It's not a part of ICU standard
@@ -283,7 +291,8 @@ messages.getMessage("about-company") == "ACME was established on 1988"
   with `i18nMessagePackBuilder.addReferenceFallbackKeyPrefix()` ([example](#sample-reference-resolution))
 - References in prefixed files are prefixed as
   well `${foo} -> ${<file-prefix>.foo}` ([example](#sample-reference-resolution-from-a-prefixed-file))
-- References can have a short notation `$common.reference` and long one `${common.reference}`. The long one is useful when
+- References can have a short notation `$common.reference` and long one `${common.reference}`. The long one is useful
+  when
   there reference is placed next to `[a-zA-Z0-9-_]`, like in `abc${common.reference}abc$`.
 
 ### Reference resolution order
@@ -292,11 +301,11 @@ Let's configure messages:
 
 ```java
 I18nMessagePack messagePack = I18nMessagePack.builder()
-    .addMessage(EN_US, "msg", "${company.name} was established on 1988")
-    .scanClassPath("/i18n/messages-{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .addFallbackKeyPrefix("fallback")
-    .build();
+        .addMessage(EN_US, "msg", "${company.name} was established on 1988")
+        .scanClassPath("/i18n/messages-{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .addFallbackKeyPrefix("fallback")
+        .build();
 ```
 
 Locations used to find the message:
@@ -314,10 +323,10 @@ If the reference is defined in a message stored in a prefixed file it will be au
 
 ```java
 I18nMessagePack messagePack = I18nMessagePack.builder()
-    .scanClassPathLocation("i18n/{prefix}/message_{locale}.yml")
-    .setDefaultLocale(PL_PL)
-    .addFallbackKeyPrefix("fallback")
-    .build();
+        .scanClassPathLocation("i18n/{prefix}/message_{locale}.yml")
+        .setDefaultLocale(PL_PL)
+        .addFallbackKeyPrefix("fallback")
+        .build();
 ```
 
 and file `i18n/company/message_en-US.yml` contains
@@ -340,6 +349,7 @@ Locations used to find the message:
 ## Type based formatters
 
 You can map arguments by their type using argument transformers:
+
 - transformation is located in the definition order
 - only the arguments used in the message are transformed
 - transformation is transitive - one value can be transformed multiple times
@@ -348,11 +358,13 @@ Example:
 
 ```java
 I18nMessages messages = I18nMessagePack.builder()
-    .addMessage(EN, "msg", "{0,number,00000.00000}")
-    .addArgumentTransformer(Foo, (foo) -> foo.getSomeNumber())
-    .buildLocalized(EN);
+        .addMessage(EN, "msg", "{0,number,00000.00000}")
+        .addArgumentTransformer(Foo, (foo) -> foo.getSomeNumber())
+        .buildLocalized(EN);
+
+messages.
 
-messages.getMessage("msg", new Foo(123.456)) == "00123.45600"
+getMessage("msg",new Foo(123.456))=="00123.45600"
 ```
 
 ## Missing messages
@@ -366,7 +378,9 @@ When message is missing, exception is thrown. This mechanism can be changed with
 i18nMessagePackBuilder.setMissingMessageHandler(customHandler);
 
 // ...or simply return message path when message is missing
-i18nMessagePackBuilder.usePathOnMissingMessage();
+i18nMessagePackBuilder.
+
+usePathOnMissingMessage();
 ```
 
 ### Missing message detection
@@ -375,6 +389,7 @@ It's important to find about missing messages as quickly as possible
 and avoid finding them on production.
 
 That's why there is an option to detect them during build phase:
+
 ```
 i18nMessagePackBuilder.validateNoMissingMessages() - throws exception on missing message
 i18nMessagePackBuilder.logMissingMessages() - simply logs a report about missing messages
@@ -384,14 +399,25 @@ i18nMessagePackBuilder.logMissingMessages() - simply logs a report about missing
 
 ```java
 I18nMessagePack.builder()
-      .addMessage(EN_US, "hello", "Hello")
-      .addMessage(PL_PL, "hello", "Cześć")
-      .addMessage(DE_DE, "bye", "Tschüss")
-      .logMissingMessages()
-      .build();
+      .
+
+addMessage(EN_US, "hello","Hello")
+      .
+
+addMessage(PL_PL, "hello","Cześć")
+      .
+
+addMessage(DE_DE, "bye","Tschüss")
+      .
+
+logMissingMessages()
+      .
+
+build();
 ```
 
 Will generate following report:
+
 ```
 Missing Messages
 ================
@@ -414,17 +440,31 @@ You can skip them using a custom missing message detector:
 
 ```java
 I18nMissingMessagesDetector detector = I18nMissingMessagesDetector.builder()
-    .skipPath(skipPath)
-    .logMissingMessages()
-    .build()
+        .skipPath(skipPath)
+        .logMissingMessages()
+        .build()
 
-I18nMessagePack.builder()
-    .addMessage(EN_US, "a.b.c.d", "MISSING")
-    .addMessage(EN_US, "x", "X")
-    .addMessage(EN_GB, "x", "X")
-    .addMessage(PL_PL, "x", "X")
-    .detectMissingMessages(detector)
-    .build();
+I18nMessagePack.
+
+builder()
+    .
+
+addMessage(EN_US, "a.b.c.d","MISSING")
+    .
+
+addMessage(EN_US, "x","X")
+    .
+
+addMessage(EN_GB, "x","X")
+    .
+
+addMessage(PL_PL, "x","X")
+    .
+
+detectMissingMessages(detector)
+    .
+
+build();
 
 // to skip a.b.c.d use one of sample path patterns as a skipPath:
 // - "a.b.c.d",
@@ -453,12 +493,12 @@ You can use file watching capabilities to speed up the development cycle:
 
 ```java
 I18nMessagePackBuidler messagesBuilder = I18nMessagePack.builder()
-    .setDefaultLocale(EN_US);
-    // ... other common settings
+        .setDefaultLocale(EN_US);
+// ... other common settings
 
 I18nMessagePack messages = devMode
-  ? messagesBuilder.scanFileSystem("src/main/resources/i18n/*").buildAndWatchForChanges()
-  : messagesBuilder.scanClassPath("i18n/*").build();
+        ? messagesBuilder.scanFileSystem("src/main/resources/i18n/*").buildAndWatchForChanges()
+        : messagesBuilder.scanClassPath("i18n/*").build();
 ```
 
 Following setup will load messages directly from project structure and watch for changes.