README file is changed

README.md

@@ -6,15 +6,11 @@ Ficto is a Python package that allows you to effortlessly generate realistic dem
 
 To install Ficto, use the following `pip` command:
 
-```bash
-pip install ficto
-```
+`pip install ficto`
 
 Generate a dataset by providing a YAML configuration file, the number of rows, and the desired file format. For example, to generate a CSV file with 100 rows using a configuration file named config.yaml, run the following command:
 
-```bash
-ficto -d config.yaml -n 100 -f csv
-```
+`ficto -d config.yaml -n 100 -f csv`
 
 ## Features
 * **Flexible Configuration:** Customize your dataset by defining columns and their types in a YAML file.
@@ -25,39 +21,13 @@ ficto -d config.yaml -n 100 -f csv
 
 ## Usage
 1. **Create Configuration File:** Create a YAML file (e.g., config.yaml) specifying the columns and their types.
-```yaml
-columns:
-  - name: ID
-    type: customseq
-    datatype: int
-    start: 1
-    step: 1
-    pos: 1
-  - name: First Name
-    type: firstname
-    datatype: string
-    pos: 2
-  - name: Last Name
-    type: lastname
-    datatype: string
-    pos: 3
-  - name: Gender
-    type: gender
-    datatype: string
-    pos: 4
-  - name: Country
-    type: country
-    datatype: string
-    countries: ['US', 'UK']
-    pos: 5
-```
+
 You can find a template [here](https://github.com/taeefnajib/ficto/blob/main/config-template.yaml) containing all the types of column you can add to your dataset. To know more about each value type, kindly read the documentation.
 
 2. **Generate Data:** Use the Ficto CLI to generate data based on your configuration.
 
-```bash
-ficto -d config.yaml -n 100 -f csv
-```
+`ficto -d config.yaml -n 100 -f csv`
+
 This command generates a CSV file inside a newly created `data` folder with 100 rows of demo data based on your data configuration file (i.e.`config.yaml`).
 
 ## Documentation
@@ -70,23 +40,23 @@ We welcome contributions to Ficto! If you'd like to contribute, please follow th
 * **Fork the Repository:** Click the "Fork" button on the top right corner of this repository.
 
 * **Clone Your Fork:** Clone the repository to your local machine.
-```bash
-git clone https://github.com/taeefnajib/ficto.git
-```
+
+`git clone https://github.com/taeefnajib/ficto.git`
+
 * **Create a Branch:** Create a new branch for your changes.
-```bash
-git checkout -b feature/new-feature
-```
+
+`git checkout -b feature/new-feature`
+
 * **Make Changes:** Make your desired changes in the code.
 
 * **Commit Changes:** Commit your changes with a descriptive commit message.
-```bash
-git commit -m "Add new feature"
-```
+
+`git commit -m "Add new feature"`
+
 * **Push Changes:** Push your changes to your fork.
-```bash
-git push origin feature/new-feature
-```
+
+`git push origin feature/new-feature`
+
 * **Create Pull Request:** Create a pull request on the original repository to propose your changes.
 
 * **Feedback and Review:** Participate in the discussion and address any feedback provided.

setup.py

@@ -1,6 +1,6 @@
 import setuptools
 
-with open("../PyPi.txt", "r", encoding="utf-8") as f:
+with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()
 
 __version__ = "0.0.4"