Added a note to the explanatory section of the binder

MrDave1999 · Nov 17, 2022 · 60b0005 · 60b0005
1 parent 5657291
commit 60b0005
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -143,6 +143,8 @@ class AppSettings
 ```
 The `EnvKey` attribute is used in case the key names do not match the properties and this is because the key names in a .env file usually follow this convention: `KEY_NAME=VALUE` (UpperCase + SnakeCase).
 
+> Note: As of version 2.3.0, it is no longer necessary to use the `EnvKey` attribute, because the binder performs an additional step: It converts the property name to UpperCaseSnakeCase and then checks if it exists in the environment. Note that this additional step only occurs if the `EnvKey` attribute is not used.
+
 Then call the `EnvBinder.Bind` method to bind the `AppSettings` class with the configuration keys:
 ```cs
 new EnvLoader().Load();

diff --git a/docs/articles/using_binder.md b/docs/articles/using_binder.md
@@ -15,6 +15,8 @@ class AppSettings
 ```
 The `EnvKey` attribute is used in case the key names do not match the properties and this is because the key names in a .env file usually follow this convention: `KEY_NAME=VALUE` (UpperCase + SnakeCase).
 
+> Note: As of version 2.3.0, it is no longer necessary to use the `EnvKey` attribute, because the binder performs an additional step: It converts the property name to UpperCaseSnakeCase and then checks if it exists in the environment. Note that this additional step only occurs if the `EnvKey` attribute is not used.
+
 In case the key names of a .env file match the properties, then it is not necessary to use the attribute (*or decorator*):
 ```cs
 class AppSettings