From ae05a9f0038e147d97938dae20a7a7bc524a14bb Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Tue, 8 Oct 2013 11:22:48 -0700 Subject: [PATCH] feat(mods): add README file --- mod/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 mod/README.md diff --git a/mod/README.md b/mod/README.md new file mode 100644 index 000000000..5fd9c1782 --- /dev/null +++ b/mod/README.md @@ -0,0 +1,10 @@ +## Etcd modules + +etcd modules (mods) are higher order pieces of functionality that only +speak to the client etcd API and are presented in the `/mod` HTTP path +of the etcd service. + +The basic idea is that etcd can ship things like dashboards, master +election APIs and other helpful services that would normally have to +stand up and talk to an etcd cluster directly in the binary. It is a +convienence and hopefully eases complexity in deployments.