From 566b9f7fde255a2307113f6b6fdf0979751ecc83 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 19 Jul 2025 16:59:53 -0400 Subject: Add support for nested structs and additional types --- doc.go | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'doc.go') 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 -- cgit v1.2.3