From 621f3fa700edd944cd6016f80b6c3578a8743ab8 Mon Sep 17 00:00:00 2001
From: Gyubong <jopemachine@naver.com>
Date: Wed, 3 Jan 2024 11:46:33 +0900
Subject: [PATCH] Update README

---
 README.md                |  1 -
 binding/python/README.md | 14 ++++++++++++--
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 4dfa8b6e..41d74fd0 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,6 @@ impl HashStore {
     }
 }
 
-
 #[async_trait]
 impl AbstractStateMachine for HashStore {
     async fn apply(&mut self, data: Vec<u8>) -> Result<Vec<u8>> {
diff --git a/binding/python/README.md b/binding/python/README.md
index 4178cb0c..c898606f 100644
--- a/binding/python/README.md
+++ b/binding/python/README.md
@@ -1,6 +1,8 @@
 # raftify-py
 
-Python binding of *raftify*.
+⚠️ This library is in a very experimental stage. The API could be broken.
+
+Python binding of [*raftify*](https://github.com/lablup/raftify).
 
 ## Quick guide
 
@@ -27,7 +29,9 @@ class SetCommand:
 
 ### Define your application Raft FSM
 
-Only 3 methods need to be implemented for the Store.
+Essentially, the following three methods need to be implemented for the `Store`.
+
+And similarly to `LogEntry`, you need to implement `encode` and `decode`.
 
 - `apply`: applies a commited entry to the store.
 - `snapshot`: returns snapshot data for the store.
@@ -106,6 +110,12 @@ await raft_node.propose()
 
 ### Debugging
 
+Raftify also provides a collection of CLI commands that let you check the data persisted in lmdb and the status of Raft Server.
+
 ```
 $ raftify_cli debug persisted ./logs/node-1
 ```
+
+```
+$ raftify_cli debug node 127.0.0.1:60061
+```