summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSimo Sorce <simo@redhat.com>2015-08-24 14:59:58 -0400
committerSimo Sorce <simo@redhat.com>2015-08-24 14:59:58 -0400
commitdce94942916cc21efda0bca87a6b45c0957eb7bf (patch)
tree743047fc9a59f16c2a332be526ace1bf6340e9e3
parente882840eb9d132bd145fbd495db28b4acfc5310b (diff)
downloadcustodia-dce94942916cc21efda0bca87a6b45c0957eb7bf.tar.gz
custodia-dce94942916cc21efda0bca87a6b45c0957eb7bf.tar.xz
custodia-dce94942916cc21efda0bca87a6b45c0957eb7bf.zip
Enhance README and point to wiki
Signed-off-by: Simo Sorce <simo@redhat.com>
-rw-r--r--README19
1 files changed, 18 insertions, 1 deletions
diff --git a/README b/README
index f3f8c29..1444715 100644
--- a/README
+++ b/README
@@ -1,4 +1,21 @@
Custodia
========
-A service to manage, retrieve and store secrets for other processes.
+A tool for managing secrets.
+
+
+Custodia is a project that aims to define an API for modern cloud applications
+that allows to easily store and share passwords, tokens, certificates and any
+other secret in a way that keeps data secure, mangeable and auditable.
+
+The Custodia project offers example implementations of cear text and encrypted
+backends, and aims to soon provide drivers to store data in external data
+stores like the Vault Project, OpenStack's Barbican, FreeIPA's Vault and
+similar.
+
+In future the Custodia project plans to enhance and enrich the API to provide
+access to even more secure means of dealing with private keys, like HSM as a
+Service and other similar security systems.
+
+See the Custodia wiki for more information about the current architecture:
+https://github.com/simo5/custodia/wiki