docs: direct users to library API (#73)

* docs: direct users to library API * Update examples/README.md --------- Co-authored-by: Maas Lalani <[email protected]>
charmbracelet · Mar 4, 2024 · ac0e6b1 · ac0e6b1
1 parent 87252e4
commit ac0e6b1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,6 @@
+# Examples
+
+For those of you who are new to Go, check out
+[pkg.go.dev](https://https://pkg.go.dev/github.com/charmbracelet/log) to
+view our library's API. From there, you can search the repo for more detailed
+usage examples for whichever functions match your use case.