diff --git a/README.md b/README.md index a6c0efe..d42b150 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +
+ # Secret Sync [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bank-vaults/secret-sync/ci.yaml?branch=main&style=flat-square)](https://github.com/bank-vaults/secret-sync/actions/workflows/ci.yaml?query=workflow%3ACI) @@ -5,21 +7,22 @@ Perform secret synchronization between secret stores (e.g. Hashicorp Vault to AWS Secret Manager) in a configurable manner. Enable seamless interoperability between different secret stores and make use of explicit API to control when, what, and how to synchronize. +
-🧩 **Supported providers** - -The list of providers is rather small since the project is still in its early stage. -We are actively working on expanding the list of supported providers, -as well as consolidating APIs across and for these providers. +### 🧩 Supported providers | **Name** | **Status** | |---------------------|----------------| | HashiCorps Vault | alpha | | Local Directory | alpha | +The list of providers is rather small since the project is still in its early stage. +We are actively working on expanding the list of supported providers, +as well as consolidating APIs across and for these providers. + + > [!WARNING] > This is an _early alpha version_ and there will be changes made to the API. -> > You can support us with your feedback, bug reports, and feature requests. ## Goal @@ -125,13 +128,9 @@ The output should contain something like: * Login with `root` as token. * Find `synced-secret-1`, `synced-secret-2`, and `synced-secret-3` keys. Note that the values might be base64 encoded. ---- ## Documentation -Here you can find documentation about various secret sync features and components. -You can use this as a reference point to create a more complete sync process based on given requirements. - ### Secret Store Secret store defines the actual secret store which will be used for API requests. A secret store can be either a **source** where the secrets are synced from or a **target** where @@ -196,6 +195,7 @@ sync: ``` Each sync action specifies one of four modes of operation depending on the specifications. +You can use this as a reference point to create a more complete sync process based on given requirements.
Action Spec: Synchronize a secret from reference