Skip to content

Commit b215a69

Browse files
authored
Makes readme cleaner and adds info of dotenv files
1 parent 82c8340 commit b215a69

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
aws-env - Secure way to handle environment variables in Docker
22
------------------------
33

4-
aws-env is a small utility that tries to solve problem of passing environment variables to applications in a secure way, especially in Docker containers.
4+
**aws-env** is a small utility that tries to solve problem of passing environment variables to applications in a secure way, especially in a Docker containers. It uses [AWS Parameter Store](https://aws.amazon.com/ec2/systems-manager/parameter-store/) to securely store applications' configuration -- ideal for storing all kind of secrets.
55

6-
It uses [AWS Parameter Store](https://aws.amazon.com/ec2/systems-manager/parameter-store/) to populate environment variables while starting application inside the container.
6+
**You can use it in two ways:**
7+
8+
1. Populate environment variables while starting application inside the docker container (default)
9+
2. Generate .env file (--format=dotenv)
710

811
## Usage
912

@@ -35,7 +38,7 @@ $ export DB_PASSWORD=$'SecretPassword'
3538

3639
### Optional Flags
3740

38-
*--recursive*
41+
#### --recursive
3942
You can pass the `--recursive` flag. When specified, aws-env will recursively fetch parameters starting from the base path specified in
4043
`AWS_ENV_PATH`. For the exported environment variables, any `/` characters from sub-paths will be converted to `_` characters. For example:
4144

@@ -51,7 +54,7 @@ export db0_DB_PASSWORD=$'SecretPassword'
5154
export db1_DB_PASSWORD=$'OtherSecretPassword'
5255
```
5356

54-
*--format*
57+
#### --format
5558

5659
Specify output format of parameters.
5760

0 commit comments

Comments
 (0)