diff --git a/README.md b/README.md
index 83e2acf..bdb2e88 100644
--- a/README.md
+++ b/README.md
@@ -40,17 +40,18 @@ To validate a CPF number:
package main
import (
- "fmt"
- "github.com/Hublastt/ValidGen/validgen"
+ "fmt"
+ validgen "github.com/Hublastt/ValidGen"
)
func main() {
- err := validgen.ValidateCPF("12345678909")
- if err != nil {
- fmt.Println("Invalid CPF:", err)
- } else {
- fmt.Println("CPF is valid")
- }
+ cpf := "123.456.789-09" // The CPF does not need to be formatted to be validated
+
+ if err := validgen.ValidateCPF(cpf); err != nil {
+ fmt.Println("Invalid CPF:", err)
+ } else {
+ fmt.Println("Valid CPF")
+ }
}
```
@@ -65,7 +66,7 @@ package main
import (
"fmt"
- "github.com/Hublastt/ValidGen/validgen"
+ validgen "github.com/Hublastt/ValidGen"
)
func main() {
@@ -77,80 +78,113 @@ func main() {
}
}
```
+
+Output:
+```
+Generated CPF: 12345678909
+```
+
-Format CPF
+Format Generated CPF
-To format a CPF number:
+To format a generated CPF number:
```go
package main
import (
"fmt"
- "github.com/Hublastt/ValidGen/validgen"
+ validgen "github.com/Hublastt/ValidGen"
)
func main() {
- formattedCPF, err := validgen.FormatCPF("12345678909")
+ cpf, err := validgen.FormatGeneratedCPF()
+
if err != nil {
- fmt.Println("Error formatting CPF:", err)
+ fmt.Println("Error generating CPF:", err)
} else {
- fmt.Println("Formatted CPF:", formattedCPF)
+ fmt.Println("Generated CPF:", cpf)
}
}
```
+
+Output:
+
+```
+Generated CPF: 123.456.789-09
+```
+
-Unformat CPF
+Format CPF
-To unformat a CPF number:
+To format a CPF number:
```go
package main
import (
"fmt"
- "github.com/Hublastt/ValidGen/validgen"
+ validgen "github.com/Hublastt/ValidGen"
)
func main() {
- unformattedCPF, err := validgen.UnformatCPF("123.456.789-09")
+
+ formattedCPF, err := validgen.FormatCPF("12345678909")
+
if err != nil {
- fmt.Println("Error unformatting CPF:", err)
+ fmt.Println("Error formatting CPF:", err)
} else {
- fmt.Println("Unformatted CPF:", unformattedCPF)
+ fmt.Println("Formatted CPF:", formattedCPF)
}
}
```
+
+Output:
+
+```
+Formatted CPF: 123.456.789-09
+```
+
-Format Generated CPF
+Unformat CPF
-To format a generated CPF number:
+To unformat a CPF number:
```go
package main
import (
"fmt"
- "github.com/Hublastt/ValidGen/validgen"
+ validgen "github.com/Hublastt/ValidGen"
)
func main() {
- formattedGeneratedCPF, err := validgen.FormatGeneratedCPF()
+ unformattedCPF, err := validgen.UnformatCPF("123.456.789-09")
+
if err != nil {
- fmt.Println("Error formatting generated CPF:", err)
+ fmt.Println("Error removing formatting:", err)
} else {
- fmt.Println("Formatted Generated CPF:", formattedGeneratedCPF)
+ fmt.Println("Unformatted CPF:", unformattedCPF)
}
}
```
+
+Output:
+
+```
+Unformatted CPF: 12345678909
+```
+
+
+
## Contributing
Contributions are welcome! If you would like to contribute, feel free to open a pull request.