first readme draft

Author: Patrick Koss

Makefile

@@ -8,3 +8,11 @@ test:
 			(cd $$dir && cargo test); \
 		fi \
 	done
+
+lint:
+	for dir in $$(find . -type d); do \
+		if [ -f $$dir/Cargo.toml ]; then \
+			echo "Running lint in $$dir"; \
+			(cd $$dir && cargo clippy); \
+		fi \
+	done

README.md

@@ -1 +1,40 @@
-# patrick-db
+<p align="center">
+ 	<img src="./media/thumbnail.png">
+</p>
+
+# PatrickDB
+![Build Status](https://img.shields.io/travis/com/patrickkoss/patrick-db/master)
+![Coverage](https://img.shields.io/codecov/c/github/patrickkoss/patrick-db)
+![License](https://img.shields.io/github/license/patrickkoss/patrick-db)
+![Version](https://img.shields.io/github/v/release/patrickkoss/patrick-db)
+![Issues](https://img.shields.io/github/issues-raw/patrickkoss/patrick-db)
+![PRs](https://img.shields.io/github/issues-pr/patrickkoss/patrick-db)
+![Forks](https://img.shields.io/github/forks/patrickkoss/patrick-db)
+![Stars](https://img.shields.io/github/stars/patrickkoss/patrick-db)
+![Language](https://img.shields.io/github/languages/top/patrickkoss/patrick-db
+
+patrick-db is a simplified Rust-based database designed to demonstrate distributed database principles. This distributed
+key-value store employs Zookeeper for replication and partitioning. Data is stored in a row-based format using a
+file-based system.
+
+The database is accessible through gRPC or REST, facilitated by Envoy for converting REST to gRPC. Additionally,
+patrick-db's storage and index engines can be integrated into other projects.
+
+# Architecture
+
+![Architecture](./media/architecture.png)
+
+Clients compatible with gRPC or REST can connect to patrick-db, such as the [cli](./server/src/client.rs) tool located in
+the [server](./server) directory.
+
+Envoy, which serves multiple purposes, is used here to interchange REST and gRPC.
+
+Zookeeper plays a role in service discovery and managing leader elections.
+
+The [router](server/src/router.rs), a gRPC server akin to the database server, interacts with Zookeeper. It identifies
+all partitions and their respective leaders and followers, directing traffic to the appropriate partition through
+hash-based partitioning. For write or read operations, it selects the leader, and for read-only operations, a follower
+is chosen.
+
+The [database](server/src/server.rs) itself is a gRPC server that implements a file-based storage system. In its role as
+a leader, it replicates data to followers using statement replication.

configmanager/src/lib.rs

@@ -212,7 +212,7 @@ fn register_service(zk_arc: &Arc<ZooKeeper>, service_id: &str, service_registry_
 
     let instance = Instance {
         id: service_id.to_owned(),
-        is_leader: is_leader,
+        is_leader,
         address: instance_address.to_string(),
     };
     let buf = bincode::serialize(&instance)?;
@@ -228,7 +228,7 @@ fn update_service(zk_arc: &Arc<ZooKeeper>, service_id: &str, service_registry_pa
 
     let instance = Instance {
         id: service_id.to_owned(),
-        is_leader: is_leader,
+        is_leader,
         address: instance_address.to_string(),
     };
     let buf = bincode::serialize(&instance)?;