Update README.md

README.md

@@ -12,77 +12,87 @@ To install this package, run the following command in your terminal:
 go get github.com/sepisoltani/persian-faker
 ```
 
-## Usage
-Below are examples of how to use the package to generate Persian first names, last names, and full names. These examples assume you have successfully installed the package and have Go set up on your system.
-
-## Generating a Random Persian First Name
+## Quick Start
+Here's how you can start using the persian-faker to generate various types of fake data:
 
+### Importing the Package
 ```go
-package main
-
-import (
-    "fmt"
-    "github.com/sepisoltani/persian-faker/providers/name"
-)
+import persianfaker "github.com/sepisoltani/persian-faker"
+```
 
-func main() {
-    loader := names.FileDataLoader{}
-    ng, err := names.NewNameGenerator(loader, 12345) // Example seed for reproducibility
-    if err != nil {
-        fmt.Println("Error initializing name generator:", err)
-        return
-    }
+### Creating a Data Generator
 
-    fmt.Println("Random First Name:", ng.RandomFirstName())
-}
+```go
+var generator = persianfaker.NewDataGenerator()
 ```
 
+### Name Provider
+* Generate a random Persian first name:
+```go
+var firstName = generator.Name.GenerateFirstName()
+```
+* Generate a random Persian last name:
+```go
+var firstName = generator.Name.GenerateLastName()
+```
+* Generate a random Persian full name:
+```go
+var firstName = generator.Name.GenerateFullName()
+```
 
+### Phone Number Provider
+* Generate a random Persian mobile number:
+```go
+var mobileNumber = generator.PhoneNumber.GeneratePersianMobileNumber()
+```
 
-## Generating a Random Persian Last Name
+### Location Provider
+* Generate a random province:
+```go
+var province = generator.Location.GenerateProvince()
+```
 
+* Generate a random city:
 ```go
-package main
+var province = generator.Location.GenerateCity()
+```
 
-import (
-    "fmt"
-    "github.com/sepisoltani/persian-faker/providers/name"
-)
+* Generate a random country:
+```go
+var province = generator.Location.GenerateCountry()
+```
 
-func main() {
-    loader := names.FileDataLoader{}
-    ng, err := names.NewNameGenerator(loader, 12345) // Example seed for reproducibility
-    if err != nil {
-        fmt.Println("Error initializing name generator:", err)
-        return
-    }
+* Generate a random address:
+```go
+var address = generator.Location.GeneratePersianAddress()
+```
 
-    fmt.Println("Random Last Name:", ng.RandomLastName())
-}
+### Bank Provider
+* Generate a random Persian bank name:
+```go
+var bankName = generator.Bank.GenerateBankName()
 ```
 
+* Generate a random Persian bank IBAN:
+```go
+var iban = generator.Bank.GenerateBankIBAN()
+```
 
+* Generate a random bank card number:
+```go
+var cardNumber = generator.Bank.GenerateBankCardNumber()
+```
 
-## Generating a Random Persian Full Name
+### Digit Provider
+* Generate a Persian digit:
+```go
+var digit = generator.Digit.GeneratePersianDigit()
+```
 
+### Bill Provider
+* Generate a random bill type:
 ```go
-package main
-
-import (
-    "fmt"
-    "github.com/sepisoltani/persian-faker/providers/name"
-)
-
-func main() {
-    loader := names.FileDataLoader{}
-    ng, err := names.NewNameGenerator(loader, 12345) // Example seed for reproducibility
-    if err != nil {
-        fmt.Println("Error initializing name generator:", err)
-        return
-    }
-
-    fmt.Println("Random Last Name:", ng.RandomFullName())
-}
+var billType = generator.Bill.GenerateBillType()
 ```
 
 ## Contributing

generator.go

@@ -1,4 +1,4 @@
-package persian_faker
+package persianfaker
 
 import (
 	"github.com/sepisoltani/persian-faker/providers/bank"