summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJeff Carr <[email protected]>2025-10-24 13:06:36 -0500
committerJeff Carr <[email protected]>2025-10-24 13:06:36 -0500
commit31e2be4b6f0388975244a0ee6a5929bdf9be2149 (patch)
tree930bfc19fbc368e53015222873a49c6851f6359b /README.md
parent7c4e482a19b0af3eac87b43f71a594518ffb3c57 (diff)
ENV vs env isn't worth the fight. lower case is lame for this thoughv0.0.7
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5a5a8a5..2e97173 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,20 @@
-# ENV Library
+# env Library
-Works like sh ENV, but is file based.
+Works like sh env, but is file based.
## Design goals
-* backwards compatible: saved files are compatible with bash ENV syntax
+* backwards compatible: saved files are compatible with bash env syntax
* simple: only string key=value pairs
* concurrent: use file locks
-* global: ENV functions can be called from anywhere
-* dynamic: automaticly detect ENV changes by the file mtime
+* global: env functions can be called from anywhere
+* dynamic: automaticly detect env changes by the file mtime
## Theory of Operation
-The core philosophy of this library is to standardize ENV in a new way
+The core philosophy of this library is to standardize env in a new way
-ENV configuration files are loaded in this defined order:
+env configuration files are loaded in this defined order:
1. /usr/share/doc/foo/foo.env # upstream application defaults
2. /etc/foo/foo.env # OS distribution defaults
@@ -24,11 +24,11 @@ ENV configuration files are loaded in this defined order:
## function examples
```
-key := ENV.Get("APIKEY")
+key := env.Get("APIKEY")
-if ENV.True("verbose") {
+if env.True("verbose") {
fmt.Println("worked")
}
-ENV.Set("LocalPort", "8080")
+env.Set("LocalPort", "8080")
```