Skip to content

Commit 84d890c

Browse files
authored
Update README.md
1 parent 1548de3 commit 84d890c

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

Diff for: README.md

+20-15
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
# Python-Random-Name-Generator
2-
[![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) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/navchandar/Python-Random-Name-Generator/issues)
2+
![workflow-status](https://github.com/navchandar/Python-Random-Name-Generator/actions/workflows/python-actions-test.yml/badge.svg)
3+
[![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)
4+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/navchandar/Python-Random-Name-Generator/issues)
35
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
46

5-
Outputs RANDOM People names, US state, counties and addresses, Countries and Company names. Useful for testing Name/Address fields with random data.
7+
8+
- Outputs RANDOM People names, US state, counties and addresses, Countries and Company names.
9+
- Useful for testing Name/Address fields with random data.
610

711
### Installation
8-
No dependencies required. Just pure Python.
12+
- No dependencies required. Just pure Python.
913

10-
Simply [download](https://github.com/navchandar/Python-Random-Name-Generator/releases/latest) the repo to your project folder and start using for your development/testing purposes.
14+
- Simply [download](https://github.com/navchandar/Python-Random-Name-Generator/releases/latest) the repo to your project folder and start using for your development/testing purposes.
1115

12-
Please add your suggestions or ideas or data [here](https://github.com/navchandar/Python-Random-Name-Generator/issues).
16+
- Please add your suggestions or ideas or data [here](https://github.com/navchandar/Python-Random-Name-Generator/issues).
1317

1418

1519
### Usage
1620
```py
17-
import random-names
18-
random-names.First() # outputs random first name
19-
random-names.Last() # outputs random last name
20-
random-names.Full() # outputs random first and last name
21-
random-names.Company() # outputs random company name
22-
random-names.Address() # outputs random Address
23-
random-names.StateCode() # outputs random US State Code
24-
random-names.States() # outputs random US State name
25-
random-names.Country() # outputs random Country name
26-
random-names.Places() # outputs random Place name
21+
import random_names
22+
random_names.First() # outputs random first name
23+
random_names.Middle() # outputs random middle name
24+
random_names.Last() # outputs random last name
25+
random_names.Full() # outputs random first and last name
26+
random_names.Company() # outputs random company name
27+
random_names.Address() # outputs random Address
28+
random_names.StateCode() # outputs random US State Code
29+
random_names.States() # outputs random US State name
30+
random_names.Country() # outputs random Country name
31+
random_names.Places() # outputs random Place name
2732
```
2833

2934
### Donate

0 commit comments

Comments
 (0)