From b6209db93ee7e35192c35a1c187dcd15cbd9c07b Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Mon, 9 Apr 2018 13:32:58 -0700 Subject: [PATCH] README: add links to "functional" Signed-off-by: Gyuho Lee --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a9024f5bb..abf6f9380 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ etcd is a distributed reliable key-value store for the most critical data of a d etcd is written in Go and uses the [Raft][raft] consensus algorithm to manage a highly-available replicated log. -etcd is used [in production by many companies](./Documentation/production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][locksmith], [vulcand][vulcand], [Doorman][doorman], and many others. Reliability is further ensured by rigorous [testing][etcd-tests]. +etcd is used [in production by many companies](./Documentation/production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [locksmith][locksmith], [vulcand][vulcand], [Doorman][doorman], and many others. Reliability is further ensured by [**rigorous testing**](https://github.com/coreos/etcd/tree/master/functional). See [etcdctl][etcdctl] for a simple command line client. @@ -33,7 +33,6 @@ See [etcdctl][etcdctl] for a simple command line client. [locksmith]: https://github.com/coreos/locksmith [vulcand]: https://github.com/vulcand/vulcand [etcdctl]: https://github.com/coreos/etcd/tree/master/etcdctl -[etcd-tests]: http://dash.etcd.io ## Community meetings @@ -46,12 +45,13 @@ etcd contributors and maintainers have bi-weekly meetings at 11:00 AM (USA Pacif ### Getting etcd -The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, [rkt][rkt], and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release]. +The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker on the [release page][github-release]. + +For more installation guides, please check out [play.etcd.io](http://play.etcd.io) and [operating etcd](https://github.com/coreos/etcd/tree/master/Documentation#operating-etcd-clusters). For those wanting to try the very latest version, [build the latest version of etcd][dl-build] from the `master` branch. This first needs [*Go*](https://golang.org/) installed (version 1.10+ is required). All development occurs on `master`, including new features and bug fixes. Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide. -[rkt]: https://github.com/rkt/rkt/releases/ -[github-release]: https://github.com/coreos/etcd/releases/ +[github-release]: https://github.com/coreos/etcd/releases [branch-management]: ./Documentation/branch_management.md [dl-build]: ./Documentation/dl_build.md#build-the-latest-version @@ -68,7 +68,6 @@ The etcd command can be simply run as such if it is moved to the system path as ```sh mv /tmp/etcd-download-test/etcd /usr/local/bin/ - etcd ``` @@ -87,13 +86,10 @@ ETCDCTL_API=3 etcdctl put mykey "this is awesome" ETCDCTL_API=3 etcdctl get mykey ``` -That's it! etcd is now running and serving client requests. For more +etcd is now running and serving client requests. For more, please check out: -- [Animated quick demo][demo-gif] -- [Interactive etcd playground][etcd-play] - -[demo-gif]: ./Documentation/demo.md -[etcd-play]: http://play.etcd.io/ +- [Interactive etcd playground](http://play.etcd.io) +- [Animated quick demo](./Documentation/demo.md) ### etcd TCP ports