Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #34

Merged
merged 1 commit into from
Oct 28, 2022
Merged

Updated README.md #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<img src="https://img.shields.io/pypi/dm/random-profile.svg">
</p>

[RandomProfile](https://pypi.org/project/random-profile/) is a powerful and simple tool to generate fake data. You can use it to mock classes, populate databases and and much more. You can check the full documentation here. Check on [Pypi](https://pypi.org/project/random-profile/)
[RandomProfile](https://pypi.org/project/random-profile/) is a powerful and simple tool to generate fake data. You can use it to mock classes, populate databases and much more. You can check the full documentation here. Check on [Pypi](https://pypi.org/project/random-profile/)
codeperfectplus marked this conversation as resolved.
Show resolved Hide resolved

## Installation

Expand All @@ -32,6 +32,7 @@ conda install random-profile # using anaconda
## Documentation

### As Python Module
You can use the RandomProfile as a module in your python code. You can check the full documentation here.
codeperfectplus marked this conversation as resolved.
Show resolved Hide resolved

```python
from random_profile import RandomProfile
Expand All @@ -58,6 +59,7 @@ rp.last_name(num=6)
```

### As Command Line Tool
You can also use the RandomProfile as a command line tool. You can check the full documentation here.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can remove this part. You can check the full documentation here. Line 62. As it's already mentioned in line 20.


```bash
random-profile --help
Expand Down