Add documentation to README

README.md

@@ -17,16 +17,17 @@ IFTG is a powerful Python package designed to create high-quality datasets for O
 1. [Why IFTG](#why-iftg)
 2. [Noises](#noises)
 3. [Installation](#installation)
-4. [Quick Start](#quick-start)
-5. [Usage](#usage)
+4. [Documentation](#documentation)
+5. [Quick Start](#quick-start)
+6. [Usage](#usage)
      - [Creators](#creators)
          - [ImageCreator](#imagecreator)
      - [Generators](#generators)
          - [ImagesGenerator](#imagesgenerator)
          - [BatchesImagesGenerator](#batchesimagesgenerator)
      - [Adders](#adders)
          - [DirectoryNoiseAdder](#directorynoiseadder)
-6. [Planned Features](#planned-features)
+7. [Planned Features](#planned-features)
 
 
 
@@ -111,6 +112,13 @@ To get started with IFTG, you'll need to install the package. You can do this us
 pip install iftg
 ```
 
+## Documentation
+To read the full documentation, visit the [IFTG documentation page](https://omarsamirz.github.io/ImageFromTextGenerator/).
+
+The documentation provides detailed guides on using all `features` of the package, with examples and `API references`.
+
+Feel free to explore the documentation to learn how to use IFTG in your projects!
+
 ## Quick Start
 To get started with IFTG, follow these simple steps:
 - **Import the Required Classes:** First, import the necessary classes from the IFTG package
@@ -271,7 +279,6 @@ To get started with IFTG, follow these simple steps:
     results.transform_images()
     ```
 
-
 ## Planned Features
 - **Support for Multiprocessing:** Enhance performance by adding multiprocessing capabilities to speed up the image generation and noise application processes.
 

docs/index.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="assets/iftg_logo.png" alt="Logo" width="60%">
+    <img src="assets/iftg_logo_small.png" alt="Logo" width="60%">
     <h1><b>Welcome to IFTG Documentation</b></h1>
 </div>
 

mkdocs.yml

@@ -2,8 +2,8 @@ site_name: ImageFromTextGenerator
 site_url: https://omarsamirz.github.io/ImageFromTextGenerator/
 
 theme:
-  favicon: assets/iftg_logo.png
-  logo: assets/iftg_logo.png
+  favicon: assets/iftg_logo_small.png
+  logo: assets/iftg_logo_small.png
   name: material
   language: en  
   features: