Merge pull request #21 from ajanata/fix-readme

The - tag skips the field, not marks as optional.
vrischmann · Dec 28, 2018 · d647766 · d647766
2 parents 3089713 + 98ae573
commit d647766
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -90,11 +90,18 @@ Optional values
 ```go
 var conf struct {
  Name string `envconfig:"optional"`
- Age int `envconfig:"-"`
 }
 ```
 
-The two syntax are equivalent.
+Skipping fields
+---------------
+
+*envconfig* supports skipping struct fields:
+```go
+var conf struct {
+ Internal string `envconfig:"-"`
+}
+```
 
 Combining multiple options in one tag
 -------------------------------------

diff --git a/doc.go b/doc.go
@@ -126,10 +126,15 @@ Sometimes you don't absolutely need a value. Here's how we tell envconfig a valu
 
  var conf struct {
  Name string `envconfig:"optional"`
- Age int `envconfig:"-"`
  }
 
-The two syntax are equivalent.
+Skipped fields
+
+Sometimes you want a field to be skipped entirely.
+
+ var conf struct {
+ Internal string `envconfig:"-"`
+ }
 
 Default values