Documentation update. (#152)

# Describe Request

Documentation update.
This commit is contained in:
Onur Cinar 2024-12-27 14:36:11 -08:00 committed by GitHub
commit c88ed08d90
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 1 deletions

View file

@ -63,7 +63,7 @@ if err != nil {
For simpler validation, you can call individual checker functions. Here is an example:
```golang
name := "John Doe"
name := "Onur Cinar"
err := checker.IsRequired(name)
if err != nil {
@ -92,6 +92,7 @@ type Person struct {
- [`digits`](DOC.md#IsDigits): Ensures the string contains only digits.
- [`email`](DOC.md#IsEmail): Ensures the string is a valid email address.
- [`fqdn`](DOC.md#IsFQDN): Ensures the string is a valid fully qualified domain name.
- [`hex`](DOC.md#IsHex): Ensures the string contains only hex digits.
- [`ip`](DOC.md#IsIP): Ensures the string is a valid IP address.
- [`ipv4`](DOC.md#IsIPv4): Ensures the string is a valid IPv4 address.
- [`ipv6`](DOC.md#IsIPv6): Ensures the string is a valid IPv6 address.

View file

@ -3,6 +3,7 @@
// license that can be found in the LICENSE file.
// https://github.com/cinar/checker
// Package v2 Checker is a Go library for validating user input through checker rules provided in struct tags.
package v2
import (