diff --git a/README.md b/README.md index 4716850..4127a01 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ # serverlessl -[![Go Report Card](https://goreportcard.com/badge/github.com/massiveco/serverlessl)](https://goreportcard.com/report/github.com/massiveco/serverlessl) +Serverless powered TLS PKI. + +## Overview + +`serverlessl` leverages cfssl to provide a TLS PKI solution with minimal requirements. It was initially concieved to provide a PKI for etcd/kubernetes clusters to allow for zero input cluster standup when combined with an instance init tool like [massiveco/headstart](https://github.com/massiveco/headstart) + +## Components + +### ca + +The `ca` function is responsible for bootstrapping the PKI + +### signer + +Leverages the Certificate Authority created by the [ca function](#ca) to sign CSRs -Serverless PKI powered by cfssl \ No newline at end of file