stklcode/jvaultconnector
stklcode/jvaultconnector
1
0
Fork 0
Code Issues Actions Releases 33 Wiki Activity

ReadMe updated

Browse Source
This commit is contained in:
Stefan Kalscheuer 2017-01-07 19:16:32 +01:00
parent 8ab9c23605
commit 69874bdceb
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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. 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 * HTTP(S) backend connector
* Ability to provide or enforce custom CA certificate * 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 * Connector Factory with builder pattern
* Tested against Vault 0.6.4 * Tested against Vault 0.6.4
**Usage Example** ## Usage Example
```java ```java
// Instantiate using builder pattern style factory // 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(); String secret = vault.readSecret("some/secret/key").getValue();
``` ```
**Maven Artifact** ## Maven Artifact
``` ```
<dependency> <dependency>
<groupId>de.stklcode.jvault</groupId> <groupId>de.stklcode.jvault</groupId>
@ -50,17 +49,17 @@ String secret = vault.readSecret("some/secret/key").getValue();
</dependency> </dependency>
``` ```
**Links** ## Links
[Project Page](http://jvault.stklcode.de) [Project Page](http://jvault.stklcode.de)
[JavaDoc API](http://jvault.stklcode.de/apidocs/) [JavaDoc API](http://jvault.stklcode.de/apidocs/)
**Planned features:** ## Planned features
* Creation and modification of policies * Creation and modification of policies
* Implement more authentication methods * Implement more authentication methods
**License** ## License
The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).