diff --git a/README.md b/README.md
index 3d2af68..e8b3a33 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,63 @@
-# goelect
-A library for the election process with no third-party dependencies.
+
+
+
+
+Goelect is an open-source Go (Golang) library for leader election. It is heavily influenced by the election component of the Raft implementation. For more details, you can refer to[Raft Wiki](https://en.wikipedia.org/wiki/Raft_(algorithm)).
+
+## Features
+* No third-party dependencies; it does not require third-party services such as ZooKeeper or Etcd.
+* Supports ***Novote*** role which does not participate in the election.
+
+
+## How to use
+### Config
+```go
+// ElectConfig is a struct that represents the configuration for an election.
+type ElectConfig struct {
+ // Timeout for heartbeat messages, in milliseconds
+ HeartBeatInterval uint
+ // Timeout for election messages, in milliseconds
+ ElectTimeout uint
+ // Timeout for connecting to peers, in seconds
+ ConnectTimeout uint
+ // List of peers in the network
+ Peers []Node
+ // Node represents the information of this node
+ Node Node
+ // State callbacks
+ CallBacks *StateCallBacks
+ // Timeout for callbacks, in seconds
+ CallBackTimeout int
+}
+```
+### Example
+`examples/onenode/node.go` is a great example of using this goelect package.
+
+Create an Elect instance:
+```go
+e, err := goelect.NewElect(&goelect.ElectConfig{
+ ElectTimeout: 200,
+ HeartBeatInterval: 150,
+ ConnectTimeout: 10,
+ Peers: peerNodes,
+ // state transition callbacks
+ CallBacks: &goelect.StateCallBacks{
+ EnterLeader: enterLeader,
+ LeaveLeader: leaveLeader,
+ EnterFollower: enterFollower,
+ LeaveFollower: leaveFollower,
+ EnterCandidate: enterCandidate,
+ LeaveCandidate: leaveCandidate,
+ },
+ // self node
+ Node: goelect.Node{
+ Address: *nodeAddress,
+ ID: *nodeAddress,
+ },
+ }, slog.Default())
+```
+Start the Elect:
+```go
+err = e.Run()
+```
+This is everything we need to do :)
diff --git a/docs/goelect-logo.svg b/docs/goelect-logo.svg
new file mode 100644
index 0000000..602f065
--- /dev/null
+++ b/docs/goelect-logo.svg
@@ -0,0 +1,163 @@
+
+
+
diff --git a/elect.go b/elect.go
index 73dcc39..a6c9ed3 100644
--- a/elect.go
+++ b/elect.go
@@ -216,11 +216,11 @@ type ElectConfig struct {
ConnectTimeout uint
// List of peers in the network
Peers []Node
- // Node information
+ // Node represents the information of this node
Node Node
// State callbacks
CallBacks *StateCallBacks
- // Timeout for callbacks
+ // Timeout for callbacks, in seconds
CallBackTimeout int
}
+