From 60c5aeab4867d486554a4adc807de074da30ebde Mon Sep 17 00:00:00 2001
From: jackspirou <jack.spirou@me.com>
Date: Sat, 14 Sep 2024 23:40:20 -0500
Subject: [PATCH] add generated README.md godc

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/README.md b/README.md
index ee9b2d6..8ddab82 100644
--- a/README.md
+++ b/README.md
@@ -91,6 +91,86 @@ if err != nil {
 // Output: Valid long ID: 7Zt3xY9pQr5W
 ```
 
+<!-- gomarkdoc:embed:start -->
+
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# publicid
+
+```go
+import "github.com/agentstation/publicid"
+```
+
+## Index
+
+- [func New\(opts ...Option\) \(string, error\)](<#New>)
+- [func NewLong\(opts ...Option\) \(string, error\)](<#NewLong>)
+- [func Validate\(id string\) error](<#Validate>)
+- [func ValidateLong\(fieldName, id string\) error](<#ValidateLong>)
+- [type Option](<#Option>)
+  - [func Attempts\(n int\) Option](<#Attempts>)
+
+
+<a name="New"></a>
+## func [New](<https://github.com/agentstation/publicid/blob/main/publicid.go#L31>)
+
+```go
+func New(opts ...Option) (string, error)
+```
+
+New generates a unique nanoID with a length of 8 characters and the given options.
+
+<a name="NewLong"></a>
+## func [NewLong](<https://github.com/agentstation/publicid/blob/main/publicid.go#L36>)
+
+```go
+func NewLong(opts ...Option) (string, error)
+```
+
+NewLong generates a unique nanoID with a length of 12 characters and the given options.
+
+<a name="Validate"></a>
+## func [Validate](<https://github.com/agentstation/publicid/blob/main/publicid.go#L60>)
+
+```go
+func Validate(id string) error
+```
+
+Validate checks if a given field name's public ID value is valid according to the constraints defined by package publicid.
+
+<a name="ValidateLong"></a>
+## func [ValidateLong](<https://github.com/agentstation/publicid/blob/main/publicid.go#L66>)
+
+```go
+func ValidateLong(fieldName, id string) error
+```
+
+validateLong checks if a given field name's public ID value is valid according to the constraints defined by package publicid.
+
+<a name="Option"></a>
+## type [Option](<https://github.com/agentstation/publicid/blob/main/publicid.go#L16>)
+
+Option is a function type for configuring ID generation.
+
+```go
+type Option func(*config)
+```
+
+<a name="Attempts"></a>
+### func [Attempts](<https://github.com/agentstation/publicid/blob/main/publicid.go#L24>)
+
+```go
+func Attempts(n int) Option
+```
+
+Attempts returns an Option to set the number of attempts for ID generation.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
+
+
+<!-- gomarkdoc:embed:end -->
+
+
 ## Makefile
 
 ```sh