From 7dc357b940a44db7028940c106564de5408da42f Mon Sep 17 00:00:00 2001
From: Mitchell Riedstra <mitch@riedstra.dev>
Date: Sat, 3 May 2025 09:53:52 -0400
Subject: Add a license and some docs

---
 main.go | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'main.go')

diff --git a/main.go b/main.go
index 8c50dc3..84dedb5 100644
--- a/main.go
+++ b/main.go
@@ -1,6 +1,35 @@
 // Package envflag is an extremely small bit of code to make configuration
 // via environment variables a little bit less of a hassle when using
 // the flag package in the standard library.
+//
+// Example:
+//
+//	package main
+//
+//	import (
+//		"flag"
+//		"fmt"
+//		"os"
+//
+//		"riedstra.dev/go/envflag"
+//	)
+//
+//	func main() {
+//		fl := flag.NewFlagSet("envflag", flag.ExitOnError)
+//
+//		var aFlag string = "some default"
+//		fmt.Println("aFlag:", aFlag)
+//
+//		envflag.String(fl, &aFlag, "a", "FLAG_A", "Set's the value of -a")
+//
+//		// By default, command line flags override environment vars.
+//		fl.Parse(os.Args[1:])
+//
+//		fmt.Println("aFlag:", aFlag)
+//	}
+//
+// Known caveat, variables set in the environment will override what the flag
+// package sees as the "default" value.
 package envflag
 
 import (
-- 
cgit v1.2.3