Skip to content

Commit 3cf59a9

Browse files
updating readme
1 parent 54e9b18 commit 3cf59a9

1 file changed

Lines changed: 1 addition & 34 deletions

File tree

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -32,43 +32,10 @@
3232

3333
[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/)
3434

35-
## Installation
36-
37-
- This is A python 3 Package.
38-
- Install python 3.0+ or Anaconda 3.0+
39-
40-
```bash
41-
pip install random-profile # using pip
42-
conda install random-profile # using anaconda
43-
```
4435

4536
## Documentation
4637

47-
### As Python Module
48-
You can use the RandomProfile as a module in your python code. You can check the full documentation here.
49-
50-
```python
51-
from random_profile import RandomProfile
52-
rp = RandomProfile(num=5)
53-
54-
rp.full_profile(num=10)
55-
```
56-
57-
for detailed documentation check [here](https://randomprofilegenerator.readthedocs.io/)
58-
59-
### As Command Line Tool
60-
You can also use the RandomProfile as a command line tool. You can check the full documentation here.
61-
62-
```bash
63-
random-profile --help
64-
Usage: random-profile [OPTIONS]
65-
```
66-
67-
```bash
68-
random-profile -n 10 -p
69-
```
70-
71-
for detailed documentation check [here](https://randomprofilegenerator.readthedocs.io/)
38+
Documentation is available at [ReadTheDocs](https://randomprofilegenerator.readthedocs.io/en/latest/)
7239

7340
## Upcoming Features
7441

0 commit comments

Comments
 (0)