Skip to content

Commit

Permalink
Update README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Just-Insane committed Apr 1, 2020
1 parent f992b94 commit e663781
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 19 deletions.
53 changes: 36 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,47 @@
[![GitHub pull requests](https://img.shields.io/github/issues-pr/Just-Insane/helm-vault.svg?style=flat-square)](https://github.com/Just-Insane/helm-vault/pulls)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/Just-Insane/helm-vault.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Just-Insane/helm-vault/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Just-Insane/helm-vault.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Just-Insane/helm-vault/context:python)
[![Build Status](https://gitlab.com/just.insane/helm-vault/badges/master/build.svg)](https://gitlab.com/just.insane/helm-vault/badges/master/build.svg)
[![Build Status](https://gitlab.com/just.insane/helm-vault/badges/master/pipeline.svg)](https://gitlab.com/just.insane/helm-vault/pipelines)

# Helm-Vault

Helm-Vault stores private data from YAML files in Hashicorp Vault. Helm-Vault should be used if you want to publicize your YAML configuration files, without worrying about leaking secret information.

## Table of Contents

1. [About the Project](#about-the-project)
1. [Project Status](#project-status)
1. [Getting Started](#getting-started)
1. [Dependencies](#dependencies)
1. [Installation](#installation)
1. [Usage and Examples](#usage-and-examples)
1. [Release Process](#release-process)
1. [Versioning](#versioning)
1. [How to Get Help](#how-to-get-help)
1. [Further Reading](#further-reading)
1. [Contributing](#contributing)
1. [License](#license)
1. [Authors](#authors)
1. [Acknowledgements](#acknowledgements)
- [Helm-Vault](#helm-vault)
- [Table of Contents](#table-of-contents)
- [About the Project](#about-the-project)
- [Project Status](#project-status)
- [Getting Started](#getting-started)
- [Dependencies](#dependencies)
- [Getting the Source](#getting-the-source)
- [Running Tests](#running-tests)
- [Other Tests](#other-tests)
- [Installation](#installation)
- [Using Helm plugin manager (> 2.3.x)](#using-helm-plugin-manager--23x)
- [Usage and Examples](#usage-and-examples)
- [Basic commands:](#basic-commands)
- [Usage examples](#usage-examples)
- [Encrypt](#encrypt)
- [Decrypt](#decrypt)
- [View](#view)
- [Edit](#edit)
- [Clean](#clean)
- [Wrapper Examples](#wrapper-examples)
- [Install](#install)
- [Template](#template)
- [Upgrade](#upgrade)
- [Lint](#lint)
- [Diff](#diff)
- [Release Process](#release-process)
- [Versioning](#versioning)
- [How to Get Help](#how-to-get-help)
- [Contributing](#contributing)
- [Further Reading](#further-reading)
- [License](#license)
- [Authors](#authors)
- [Acknowledgments](#acknowledgments)

# About the Project

Expand Down Expand Up @@ -58,9 +77,9 @@ Input a value for /nextcloud/password:

Build Status:

[![Build Status](https://gitlab.com/just.insane/helm-vault/badges/master/build.svg)](https://gitlab.com/just.insane/helm-vault/badges/master/build.svg)
[![Build Status](https://gitlab.com/just.insane/helm-vault/badges/master/pipeline.svg)](https://gitlab.com/just.insane/helm-vault/pipelines)

Helm-Vault is in an pre-production state currently. It should work across platforms, and should be able to handle most YAML thrown at it, but it is missing some features.
Helm-Vault is in a production state. It should work across platforms, and should be able to handle most YAML thrown at it.

**[Back to top](#table-of-contents)**

Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ Thanks for contributing! :heart:

[//]: # (Simply change the URL's below to your own project information)

[issues]: https://gitlab.com/Just-Insane/helm-vault/issues
[new-issue]: https://gitlab.com/Just-Insane/helm-vault/issues/new
[issues]: https://github.com/Just-Insane/helm-vault/issues
[new-issue]: https://github.com/Just-Insane/helm-vault/issues/new/choose

0 comments on commit e663781

Please sign in to comment.