Skip to content

Commit 4c36974

Browse files
committed
docs: polishing
1 parent f82120a commit 4c36974

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,13 @@ with some differences:
4646
directory.
4747
- Spring Boot support: dotenvx CLI can read `application.properties` and spring profile.
4848
- Global `--profile` as first citizen to make it easy to manage different environments
49-
- More smaller features
49+
- More smaller features: lint, diff etc.
5050
- No ext sub command
5151

5252
### Migrated to dotenvx CLI
5353

5454
If you have .env files already, you just run `dotenvx init`, and dotenvx CLI will create `.env` file with Dotenvx
55-
format,
56-
and save the private key to `$HOME/.dotenvx/.env.keys.json` file.
55+
format, and save the private key to `$HOME/.dotenvx/.env.keys.json` file.
5756

5857
# .env file specification
5958

@@ -71,7 +70,8 @@ Example as following:
7170
DOTENV_PUBLIC_KEY="02b4972559803fa3c2464e93858f80c3a4c86f046f725329f8975e007b393dc4f0"
7271

7372
# Environment variables. MAKE SURE to ENCRYPT them before committing to source control
74-
HELLO=encrypted:BNexEwjKwt87k9aEgaSng1JY6uW8OkwMYEFTwEy/xyzDrQwQSDIUEXNlcwWi6rnvR1Q60G35NO4NWwhUYAaAON1LOnvMk+tJjTQJaM8DPeX2AJ8IzoTV44FLJsbOiMa77RLrnBv7
73+
# @example="jdbc:mysql://localhost:3306/test"
74+
JDBC_URL=encrypted:BNexEwjKwt87k9aEgaSng1JY6uW8OkwMYEFTwEy/xyzDrQwQSDIUEXNlcwWi6rnvR1Q60G35NO4NWwhUYAaAON1LOnvMk+tJjTQJaM8DPeX2AJ8IzoTV44FLJsbOiMa77RLrnBv7
7575
```
7676

7777
Explanation:
@@ -80,7 +80,8 @@ Explanation:
8080
- .env file UUID: a unique identifier for the .env file, used to track changes and versions
8181
- sign: a signature for the .env file, used to verify the integrity of the file and make sure the file is not tampered
8282
- DOTENV_PUBLIC_KEY: the public key used to encrypt data and verify the signature
83-
- Environment variables: the encrypted environment variables, starts with `encrypted:` prefix
83+
- Environment variables: the encrypted environment variables, starts with `encrypted:` prefix.
84+
- [env.spec](https://github.com/dmno-dev/varlock/discussions/17): you can add comments and annotations for variables alike JSDOC.
8485

8586
In metadata section, you can add any key-value pairs to describe the .env file, such as `name`, `group`, etc.
8687

0 commit comments

Comments
 (0)