docs: enhance documentation

README.md

@@ -3,7 +3,8 @@
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Tochemey/gokv/build.yml)]((https://github.com/Tochemey/gokv/actions/workflows/build.yml))
 
 Simple Distributed in-memory key/value store. GoKV provides high availability and fault tolerance which makes it suitable large-scale applications system without sacrificing performance and reliability. 
-With GoKV, you can instantly create a fast, scalable, distributed system  across a cluster of computers.
+With GoKV, you can instantly create a fast, scalable, distributed system  across a cluster of computers. Go-KV uses the push-pull anti-entropy method to replicate nodes' state across the cluster. This 
+approach makes Go-KV eventually consistent. 
 
 ## Installation
 

cluster/config.go

@@ -36,6 +36,7 @@ import (
 // Config defines the cluster config
 type Config struct {
 	// specifies the maxJoinAttempts
+	// This specifies the number of attempts to make when trying to join an existing cluster
 	maxJoinAttempts int
 	// specifies the join retry interval
 	joinRetryInterval time.Duration
@@ -44,14 +45,21 @@ type Config struct {
 	// specifies the node client port
 	port uint16
 	// specifies the node discovery port
+	// The discoveryPort is used for both UDP and TCP gossip.
 	discoveryPort uint16
 	// specifies the shutdown timeout
 	shutdownTimeout time.Duration
 	// specifies the logger
 	logger log.Logger
 	// specifies the host
+	// This is the ip address of the running node.
 	host string
 	// specifies the state sync interval
+	// This is the interval between complete state syncs.
+	// Complete state syncs are done with a single node over TCP and are
+	// quite expensive relative to standard gossiped messages.
+	// Setting this interval lower (more frequent) will increase convergence
+	// speeds across larger clusters at the expense of increased bandwidth usage.
 	stateSyncInterval time.Duration
 }