Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ramizpolic committed Sep 14, 2023
1 parent f7e180d commit 247c153
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ Enables secret synchronization between two secret store services (e.g. between H
- Hashicorp Vault
- FileDir (store is a folder, secrets are plain unencrypted files)

### Quick usage
Synchronize specific secrets every hour between two Hashicorp Vault instance.
### Examples

<details>
<summary>Synchronize specific secrets every hour between two Hashicorp Vault instance</summary>

#### Define stores
```yaml
Expand All @@ -36,7 +38,7 @@ vault:
token: "root"
```
### Define sync strategy
#### Define sync strategy
```yaml
### SyncJob: path/to/sync-job.yaml
schedule: "@every 1h"
Expand Down Expand Up @@ -126,5 +128,7 @@ secret-sync --source path/to/vault-source.yaml \
# Use --schedule "@every 1m" to override sync job file config.
```

</details>

### Docs
Check documentation and example usage at [DOCS](docs/).

0 comments on commit 247c153

Please sign in to comment.