Skip to content

Commit

Permalink
Inlcude warning note because its not apparent
Browse files Browse the repository at this point in the history
  • Loading branch information
belibug committed Jun 22, 2024
1 parent 0fef68b commit 33a85bd
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ This PowerShell module offers essential functionality for backing up (exporting
- Provides Cross-platform capability to backup and restore (e.g., Windows to Mac) Secrets.
- Migrate secrets from one store backend to different one. (e.g., KeePass to AzureVault Migration).

> [!IMPORTANT]
> Currently it supports secret saved as string, securestring and PSCredential only, does not support secret of type Byte and Hastable
> [!WARNING]
> This module complements [SecretManagement][SecretManagementGithub] module and assumes that you have at least one secret store configured and working.
## Features

- Export PowerShell Secret Store as plain JSON
- Restore PowerShell Secret Store from JSON
- Retain any metadata content in secret

> [!IMPORTANT]
> Currently it supports secret saved as string, securestring and PSCredential only, does not support secret of type Byte and Hastable
## Installation

To install the module, you can use the PowerShell Gallery:
Expand Down Expand Up @@ -69,4 +72,4 @@ This project is licensed under the MIT License. See the LICENSE file for details
- [SecretStore module][SecretStoreGithub]

[SecretManagementGithub]: https://github.com/PowerShell/SecretManagement
[SecretStoreGithub]: https://github.com/PowerShell/SecretStore
[SecretStoreGithub]: https://github.com/PowerShell/SecretStore

0 comments on commit 33a85bd

Please sign in to comment.