From 0540ed869d4ec774ea038b55b5b727bfb28beb07 Mon Sep 17 00:00:00 2001
From: taeefnajib <taeefnajib@gmail.com>
Date: Sat, 25 Nov 2023 06:18:21 +0600
Subject: [PATCH] README file is changed

---
 PyPi.txt  | 35 ------------------------------
 README.md | 64 +++++++++++++++----------------------------------------
 setup.py  |  2 +-
 3 files changed, 18 insertions(+), 83 deletions(-)
 delete mode 100644 PyPi.txt

diff --git a/PyPi.txt b/PyPi.txt
deleted file mode 100644
index c643217..0000000
--- a/PyPi.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-# Ficto - Generate Realistic Demo Data
-
-Ficto is a Python package that allows you to effortlessly generate realistic demo data in CSV or JSON format. With Ficto, you can create datasets with various column types by simply specifying them in a YAML configuration file.
-
-## Installation & Quick Start
-
-To install Ficto, use the following `pip` command:
-`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:
-`ficto -d config.yaml -n 100 -f csv`
-
-## Features
-* **Flexible Configuration:** Customize your dataset by defining columns and their types in a YAML file.
-* **Multiple Formats:** Generate datasets in either CSV or JSON format.
-* **Easy Installation:** Install Ficto effortlessly with a single pip command.
-* **Realistic Demo Data:** Create realistic data for testing purpose.
-* **Command-Line Interface (CLI):** User-friendly CLI for quick and simple data generation.
-
-## Usage
-1. **Create Configuration File:** Create a YAML file (e.g., config.yaml) specifying the columns and their types.
-
-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.
-
-`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
-For more details and advanced usage, refer to the Ficto Documentation.
-
-## License
-This project is licensed under the [MIT License](https://github.com/taeefnajib/ficto/blob/main/LICENSE)
\ No newline at end of file
diff --git a/README.md b/README.md
index 2918697..5c1ebed 100644
--- a/README.md
+++ b/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.
diff --git a/setup.py b/setup.py
index fb9a334..97de93f 100644
--- a/setup.py
+++ b/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"