Merge pull request #27 from codePerfectPlus/doc-patch

updaing docs for readthedocs

docs/README.md

@@ -1,11 +1,21 @@
-# Random Profile Generator
+<h1 align="center">
+  <br>
+  Random Profile Generator V0.2.3
+  <br>
+</h1>
 
-## Introduction
+<h4 align="center">Python Module To Generate Random Profile Data</h4>
 
-RandomProfile 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.
+[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/)
 
-```python
-pip install random-profile
+## Installation
+
+- This is A python 3 Package.
+- Install python 3.0+ or Anaconda 3.0+
+
+```bash
+pip install random-profile   # using pip
+conda install random-profile # using anaconda
 ```
 
 ## Documentation
@@ -20,29 +30,24 @@ default is 1
 change the num value according to your needs.
 
 '''
-# For First Name
-rp.first_name()
+# num can be overwritten in the function
 
-# For First Name
-rp.full_name()
+# For first name
+rp.first_name(num=10)
 
-# For First Name
-rp.full_profile()
-```
+# For full name
+rp.full_name(num=8)
 
-## Installation
-
-- This is A python 3 Package.
-- Install python 3.0+ or Anaconda 3.0+
+# override the num value
+rp.full_profile(num=10)
 
-```python
-Pip install random-profile   #on python
-conda install random-profile # on anacoda
+# For last name
+rp.last_name(num=6)
 ```
 
 ## Usage
 
-random-profile module is a random profile generator for many usages ex- fake dataset,youtube videos, content creation, personal projects.
+the random-profile module is a random profile generator for many usages like: ex- fake dataset, YouTube videos, content creation, personal projects.
 
 ## Support
 
@@ -55,7 +60,25 @@ Contributors for the Project
 what's new in future update
 
 - More Random data will be added to package.
-- variety of Random-Data will increase.
+- Variety of Random-Data will increase.
+
+## Changelog
+
+v0.2.3
+- Flask app added
+- Date of Birth Added
+- Age added
+- Height and Weight Added
+- Blood Group and hair color added
+- Job title added
+- More email domains added
+- Bugs Fixed
+
+v0.2.1
+- More variation added to the data
+- Test cases added
+- Created a separate file for data loadings
+- Fixed some bugs
 
 ## Contributing
 
@@ -65,22 +88,18 @@ Perform basic troubleshooting steps:
 
 - Make sure you are on the latest version. If you are not on the most recent version, your problem may have been solved already! Upgrading is always the best first step.
 - Try older versions. If you are already on the latest release, try rolling back a few minor versions (e.g. if on 1.7, try 1.5 or 1.6) and see if the problem goes away. This will help the devs narrow down when the problem first arose in the commit log.
-- Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading/downgrading those as well.
+- Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading and downgrading those dependencies as well.
 
 ## Authors and acknowledgment
 
 Show your appreciation to those who have contributed to the project.
 
 ## License
 
-For open source projects,Under MIT License.
-
-## Project status
+The project is licensed under the <a href="/LICENSE">MIT</a> license. 
 
-## Author
+## Contributors
 
-- Module : random-profile
-- Author  : CodePerfectPlus
-- Language : Python
-- Github : <https://github.com/codePerfectPlus>
-- Website : <http://codeperfectplus.github.io/>
+<a href="https://github.com/codePerfectPlus/awesomeScripts/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=codePerfectPlus/randomprofilegenerator" />
+</a>