doc

README.md

@@ -1,7 +1,9 @@
 # Dynamic configuration
 
-This repo implements a dynamic configuration repository. It leverages [mongodb change-streams](https://www.mongodb.com/docs/manual/changeStreams/) 
-to stream changes that happens in a configuration collection into the local configuration repository. 
+![](doc/img.png)
+
+This library implements a hot-reloadable configuration repository. It leverages [mongodb change-streams](https://www.mongodb.com/docs/manual/changeStreams/) 
+to stream changes that happen in a configuration collection into the local configuration repository.
 
 This pattern can be used in distributed systems for feature-flag activations/deactivations and for distributed 
  eventually-consistent hot-reloadable configuration changes. 
@@ -11,14 +13,15 @@ A typical usecase is a kubernetes replicaset with multiple pods - upon configura
 * default values are not persisted, they are local-only. This allows you to change default values 
 when rolling out new configuration versions.
 
-The provided configuration must support `json` field tags for serialization. 
+The user-provided configuration must support `json` field tags for serialization/deserialization.
 
 ## Design
 
-* Auditable - the lib aims at keeping historical information about configuration changes - this is achieved at the price of 
+* Auditable: the lib aims at keeping historical information about configuration changes - this is achieved at the price of 
 a higher storage usage as each configuration change translates to a new document in the collection containing all configuration 
 fields.
-* Immutable - the configurations are versioned and immutable - every update is reflected as a new document.
+* Immutable: the configurations are versioned and immutable - every update is reflected as a new document.
+* Eventually-consistent: a configuration change will be replicated to the other local repositories eventually.
 
 ## Usage
 
@@ -32,5 +35,5 @@ checkout the [example](./example/main.go).
 
 ```shell
 make dependencies_up
-make 
+make tests
 ```