Skip to content

Commit

Permalink
fix(readme): update readme with notes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdial89f committed Apr 20, 2022
1 parent d89fb84 commit 82c24f9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
</a>
</p>

** NOTE: This package is currently in a storming phase and published as a 1.x version. Features, fixes, and general repository updates are happening frequently. A 2.x version will be released when the storming is over.

## Usage

Install to your project with your packager manager of choice, likely as a dev dependency:
Expand All @@ -46,6 +48,10 @@ destroyer.destroy("us-east-1", "foo");

## Assorted Notes/Considerations

This package is designed to prompt the user to confirm they want to proceed with destroying a given stage, by way of asking for re-input of the stage name. If the environment variable CI is present and set to true, as is the case for most CI systems, this confirmation is bypassed.

This package is designed to refuse to destroy stages named master, main, staging, or production. There may be use cases where destroying stages with those names is desired, but this package doesn't want to help with that for now.

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
Expand Down

0 comments on commit 82c24f9

Please sign in to comment.