summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSimo Sorce <simo@redhat.com>2015-10-19 14:17:53 -0400
committerSimo Sorce <simo@redhat.com>2015-10-19 14:17:53 -0400
commit424b17b477677e12ca7f53f132cfa46fb58038fa (patch)
treeb12366eaff285c510e2d135982513777330a37ac
parentcecc8bd76160f08c05375a9b6d6e90699091be30 (diff)
downloadcustodia-424b17b477677e12ca7f53f132cfa46fb58038fa.zip
custodia-424b17b477677e12ca7f53f132cfa46fb58038fa.tar.gz
custodia-424b17b477677e12ca7f53f132cfa46fb58038fa.tar.xz
Split README and README.mdHEADmaster
The latter is customized to show Travis' CI build status on Github, and will have more hosting specific content going forward. The regular README will be targeted for offline information, and will not be necessarilya markdown file either. Signed-off-by: Simo Sorce <simo@redhat.com>
-rw-r--r--[l---------]README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 100b938..6fdbb75 120000..100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-README \ No newline at end of file
+[![Build Status](https://travis-ci.org/simo5/custodia.svg?branch=master)](https://travis-ci.org/simo5/custodia)
+
+Custodia
+========
+
+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 clear 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