Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
armanyazdi committed Jul 14, 2024
1 parent 4985540 commit 7a5dad3
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ A Python library for generating random Persian (Farsi) names.
This package generates frequently logical names
(a mix of popular Persian and Arabic names with common Persian family name suffixes).

Note: `persian-names` generates **90,000,000** unique full names (As Iran population in 2024) in less than 3 minutes.

## Installation

Install from [PyPI](https://pypi.org/project/persian-names) with pip by typing in your favorite terminal:
Expand All @@ -34,7 +36,7 @@ fullname_fa('random') # or fullname_fa('r')
from persian_names import fullname_fa

print(fullname_fa('m')) # اشکان محمدرضائیان
print(fullname_fa('f')) # مهسا امیری
print(fullname_fa('f')) # مهسا امیری تهرانی
print(fullname_fa('r')) # بیتا خسروی راد
```

Expand All @@ -55,7 +57,7 @@ from persian_names import fullname_en

print(fullname_en('m')) # Arsalan Mohammadi
print(fullname_en('f')) # Sara Alipour
print(fullname_en('r')) # Danial Ferdosi
print(fullname_en('r')) # Danial Ferdosi Khorasani
```

### Generate First Names and Last Names in Farsi:
Expand Down Expand Up @@ -108,6 +110,14 @@ print(firstname_en('r')) # Baran
print(lastname_en()) # Bakhtiarizadeh
```

## Issues

Feel free to submit issues and enhancement requests.

## Contributing

Feel free to contribute names database with your kindly pull requests.

## License

`persian-names` is available under the [MIT license](https://github.com/armanyazdi/persian-names/blob/main/LICENSE).

0 comments on commit 7a5dad3

Please sign in to comment.