Browse Source

add a little intro

Alex Polvi 12 years ago
parent
commit
9b361f6d36
1 changed files with 14 additions and 0 deletions
  1. 14 0
      README.md

+ 14 - 0
README.md

@@ -1,5 +1,19 @@
 # etcd
 # etcd
 
 
+A highly-available key value store for shared configuration and service discovery. etcd is inspired by zookeeper and doozer, with a focus on:
+
+* Simple: curl'able user facing API (HTTP+JSON)
+* Secure: optional SSL client cert authentication
+* Fast: benchmarked 1000s of writes/s per instance
+* Reliable: Properly distributed using paxos
+
+Etcd is written in go and uses the [raft][raft] paxos implementation for high availability. 
+
+See [go-etcd][go-etcd] for a native go client. Or feel free to just use curl, as in the examples below. 
+
+[raft]: https://github.com/coreos/go-raft
+[go-etcd]: https://github.com/coreos/go-etcd
+
 ## Getting Started
 ## Getting Started
 
 
 ### Building
 ### Building