aboutsummaryrefslogtreecommitdiffstats
path: root/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc.go b/doc.go
index 834d87a..1a9f0c1 100644
--- a/doc.go
+++ b/doc.go
@@ -1,3 +1,12 @@
-// Envelope is a library designed to enable easily populating a Go struct
-// based on environment variables.
+// Envelope provides functionality to populate Go structs from environment variables.
+//
+// The main function, LoadFromEnv, takes a pointer to a struct and looks for fields
+// with the `env` tag. It then attempts to load the corresponding environment variables
+// and parse them into the appropriate types.
+//
+// This package supports a wide range of built-in types and allows for extension through
+// custom type parsers. It also handles nested structs, with the parent field's `env` tag
+// serving as a prefix for all fields in the nested struct.
+//
+// See the documentation for LoadFromEnv for more details and examples.
package envelope