diff --git a/README.md b/README.md index 098fccf..4bf57e3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -Java Vault Connector -========= +# Java Vault Connector [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/stklcode/jvaultconnector/blob/master/LICENSE.txt) [![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.jvault/connector.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.jvault%22%20AND%20a%3A%22connector%22) Java Vault Connector is a connector library for [Vault](https://www.vaultproject.io) by [Hashicorp](https://www.hashicorp.com) written in Java. The connector allows simple usage of Vault's secret store in own applications. -**Features:** +## Features: * HTTP(S) backend connector * Ability to provide or enforce custom CA certificate @@ -24,7 +23,7 @@ Java Vault Connector is a connector library for [Vault](https://www.vaultproject * Connector Factory with builder pattern * Tested against Vault 0.6.4 -**Usage Example** +## Usage Example ```java // Instantiate using builder pattern style factory @@ -41,7 +40,7 @@ vault.authToken("01234567-89ab-cdef-0123-456789abcdef"); String secret = vault.readSecret("some/secret/key").getValue(); ``` -**Maven Artifact** +## Maven Artifact ``` de.stklcode.jvault @@ -50,17 +49,17 @@ String secret = vault.readSecret("some/secret/key").getValue(); ``` -**Links** +## Links [Project Page](http://jvault.stklcode.de) [JavaDoc API](http://jvault.stklcode.de/apidocs/) -**Planned features:** +## Planned features * Creation and modification of policies * Implement more authentication methods -**License** +## License The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).