Skip to content

Commit 87469bd

Browse files
authored
Minor clarifications added for #1 and #12
1 parent ca84017 commit 87469bd

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
## DotEnv file (.env) support for Delphi
33

44
- Add DotEnv file support by including `radDotEnv.pas` in your project
5-
- Optional `dotenv` singleton variable created at startup (disabled by default)
5+
- `DotEnv` singleton variable created at startup (option can be disabled)
6+
- Simple add the radDotEnv unit to your uses clause and use `DotEnv.Get('VariableName')`
67
- Fully complies with DotEnv Draft RFC: https://github.com/radprogrammer/dotenv-RFC
7-
- No exceptions are raised on parsing issues to prevent difficult to debug application startup issues
8+
- No exceptions are raised on parsing issues to prevent difficult to debug application startup issues (a logging hook is available)
89
- Custom paths can be searched (only the directory of the application is searched by default)
910
- Custom filenames can be used (utilizes `.env` by default)
1011
- Custom file encoding can be specified (defaults to UTF8 by default)
@@ -15,7 +16,7 @@
1516
- `KEY= Unquoted Values are trimmed ` Value=`Unquoted Values are trimmed`
1617
- `# full line comments supported`
1718
- `KEY=TEXT #inline comments supported` Value=`TEXT`
18-
- `KEY=TEXT#also inline comment (no space required)` Value=`TEXT`
19+
- `KEY=TEXT#also inline comment (no space required)` Value=`TEXT` (see [Open Issue 12](https://github.com/radprogrammer/rad-dotenv/issues/12))
1920
- `KEY="DoubleQuoted"` Value=`DoubleQuoted`
2021
- `KEY='SingleQuoted'` Value=`SingleQuoted`
2122
- `KEY TEXT improperly formatted lines are ignored`
@@ -35,7 +36,7 @@ KEY2="ValueFromKey1=${KEY1}" # Value=ValueFromKey1=VALUE1
3536
````
3637
KEY="Value${UnknownKey-123}" # Value=Value123
3738
````
38-
- Available option to support variable substitution in Unquoted values
39+
- Available option to support variable substitution within Unquoted values (option is disabled by default)
3940
````
4041
KEY1=VALUE1
4142
KEY2=ValueFromKey1=${KEY1} # Value=ValueFromKey1=VALUE1

0 commit comments

Comments
 (0)