Skip to content

Commit a2780dd

Browse files
authored
Updated usage
1 parent df162e6 commit a2780dd

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

Diff for: README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# Python-Random-Name-Generator
22
[![Code Climate](https://codeclimate.com/github/navchandar/Python-Random-Name-Generator.svg)](https://codeclimate.com/github/navchandar/Python-Random-Name-Generator) [![license](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/navchandar/Python-Random-Name-Generator/blob/master/LICENSE) [![HitCount](http://hits.dwyl.io/navchandar/Python-Random-Name-Generator.svg)](http://hits.dwyl.io/navchandar/Python-Random-Name-Generator) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/navchandar/Python-Random-Name-Generator/issues)
3+
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
4+
5+
Outputs RANDOM People names, US state, counties and addresses, Countries and Company names. Useful for testing Name/Address fields with random data.
6+
7+
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/navchandar)
38

4-
Outputs RANDOM People names, US state, counties and addresses, Countries and Company names.
59

610
### Installation
7-
No dependencies required. Just pure Python and text files.
8-
Download the repo to your project folder.
11+
No dependencies required. Just pure Python. Download the repo to your project folder and start using.
12+
913

1014
### Usage
1115
```py
1216
import random-names
13-
random-names.First()
14-
random-names.Last()
15-
...
17+
random-names.First() # outputs random first name
18+
random-names.Last() # outputs random last name
19+
random-names.Full() # outputs random first and last name
20+
random-names.Company() # outputs random company name
21+
random-names.Address() # outputs random Address
22+
random-names.StateCode() # outputs random US State Code
23+
random-names.States() # outputs random US State name
24+
random-names.Country() # outputs random Country name
25+
random-names.Places() # outputs random Place name
1626
```
1727

0 commit comments

Comments
 (0)