Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hqdncw authored Jul 1, 2024
1 parent 373f559 commit ac6529c
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# vault-autopilot

Effortlessly manage your Vault secrets with the power of automation.
![Docker Pulls](https://img.shields.io/docker/pulls/hqdncw/vault-autopilot?link=https%3A%2F%2Fhub.docker.com%2Fr%2Fhqdncw%2Fvault-autopilot)
![PyPI - Downloads](https://img.shields.io/pypi/dm/vault-autopilot?link=https%3A%2F%2Fpypi.org%2Fproject%2Fvault-autopilot%2F)
[![Documentation](https://img.shields.io/badge/docs-latest-teal.svg)](https://hqdncw.github.io/vault-autopilot/index.html)

## What is Vault Autopilot?

Optimize your Vault resource configuration with Vault Autopilot's declarative
YAML manifest files! By leveraging a patch-based approach, this sweet tool
ensures your Vault server converges to a desired state with minimal deltas.


## Key Features

- **Manifest Files**: Define your Vault resources using sick YAML
files. Because who doesn't love YAML?
- **Automated Resource Management**: Vault Autopilot applies the
necessary changes to your Vault server to achieve the desired state.
Seamless, effortless, and only occasionally frustrating.
- **CLI Tool**: Interact with Vault Autopilot using a powerful CLI tool,
complete with a range of commands and options for managing your Vault
resources. It won't crash... most of the time.


## Getting Started: The "Wing It" Approach

To get started with Vault Autopilot 0.1.0, please refer to our [documentation](https://hqdncw.github.io/vault-autopilot/cli/getting_started.html), which provides a comprehensive guide to setting up and using Vault Autopilot. Or, you know, just wing it and hope for the best.

0 comments on commit ac6529c

Please sign in to comment.