From 358debf2fa3122ac66d80cd0a6011fce807d13f9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Malo=20L=C3=A9on?= <malo.leon@wyatt-studio.fr>
Date: Tue, 28 Feb 2023 17:50:16 +0100
Subject: [PATCH] docs(ui_layout-bloc_layouts): add readmes

---
 packages/wyatt_bloc_layout/README.md | 43 +++++++++++++++++++++----
 packages/wyatt_ui_layout/README.md   | 48 ++++++++++++++++++++++++----
 2 files changed, 77 insertions(+), 14 deletions(-)

diff --git a/packages/wyatt_bloc_layout/README.md b/packages/wyatt_bloc_layout/README.md
index 057115c4..b31892df 100644
--- a/packages/wyatt_bloc_layout/README.md
+++ b/packages/wyatt_bloc_layout/README.md
@@ -16,7 +16,6 @@
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
 -->
 
-
 # Flutter - Wyatt Bloc Layout
 
 <p align="left">
@@ -28,16 +27,46 @@
 
 Bloc Layout for Flutter.
 
+Wyatt Bloc Layout is a Flutter package that builds on the Wyatt UI Layout package and the Wyatt Bloc Helper package. It provides a way to link multiple packages in order to create intelligent layouts that combine both layout and logic. The package allows developers to use the available layouts in the Wyatt UI Layout package along with the block state logic available in the Wyatt Bloc Helper package. It also uses the Wyatt Crud Bloc package to make it easier to implement CRUD logic.
 
+### Features
 
-## Features
+- Allows developers to use available layouts from Wyatt UI Layout package.
+- Links with the Wyatt Bloc Helper package to combine layout and block state logic.
+- Uses the Wyatt Crud Bloc package to easily implement CRUD logic.
 
-<!-- TODO -->
+#### Available bloc layouts
 
-## Getting started
+- BottomNavigationBarGridLayoutCubitScreenCrudList
+- BottomNavigationBarLayoutCubitScreen
+- BottomNavigationBarLayoutCubitScreenCrud
+- BottomNavigationBarLayoutCubitScreenCrudItem
+- BottomNavigationBarLayoutCubitScreenCrudList
+- FrameGridLayoutCubitScreenCrudList
+- FrameLayoutCubitScreen
+- FrameLayoutCubitScreenCrud
+- FrameLayoutCubitScreenCrudItem
+- FrameLayoutCubitScreenCrudList
+- TopAppBarGridLayoutCubitScreenCrudList
+- TopAppBarLayoutCubitScreen
+- TopAppBarLayoutCubitScreenCrud
+- TopAppBarLayoutCubitScreenCrudItem
+- TopAppBarLayoutCubitScreenCrudList
+- TopNavigationBarGridLayoutCubitScreenCrudList
+- TopNavigationBarLayoutCubitScreen
+- TopNavigationBarLayoutCubitScreenCrud
+- TopNavigationBarLayoutCubitScreenCrudItem
+- TopNavigationBarLayoutCubitScreenCrudList
 
-<!-- TODO -->
+### Installation
 
-## Usage
+To use Wyatt Bloc Layout in your Flutter project, add the following dependency to your pubspec.yaml file:
 
-<!-- TODO -->
\ No newline at end of file
+```yaml
+wyatt_bloc_layout:
+  git:
+    url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
+    path: packages/wyatt_bloc_layout
+```
+
+Then, run flutter pub get to download the package.
diff --git a/packages/wyatt_ui_layout/README.md b/packages/wyatt_ui_layout/README.md
index 2cbb1aab..e8d1656d 100644
--- a/packages/wyatt_ui_layout/README.md
+++ b/packages/wyatt_ui_layout/README.md
@@ -1,5 +1,5 @@
 <!--
- * Copyright (C) 2022 WYATT GROUP
+ * Copyright (C) 2023 WYATT GROUP
  * Please see the AUTHORS file for details.
 
  * This program is free software: you can redistribute it and/or modify
@@ -25,11 +25,45 @@
   <img src="https://img.shields.io/badge/SDK-Flutter-blue?style=flat-square" alt="SDK: Flutter" />
 </p>
 
-Wyatt Ui Layout for Flutter
+Wyatt UI Layout is a Flutter package that provides pre-built layouts to make the development of graphical user interfaces (GUIs) easier. There are two types of layouts provided by this package: structural and content layouts.
 
-## Features.
+### Structural Layouts
 
-- Layouts :
-  - App Bar Layout
-  - Bottom Navigation Bar Layout
-  - Frame Layout (wrapp both appbar & bottom bar)
+Structural layouts are used to structure the GUI, and there are currently four layouts provided by this package:
+
+- #### TopAppBarLayout
+
+This layout is used to create a GUI with a classic app bar and a body.
+
+- #### TopNavigationBarLayout
+
+This layout is used to create a GUI with an app bar that includes navigation options and a body.
+
+- #### BottomNavigationBarLayout
+
+This layout is used to create a GUI with a bottom bar that includes navigation options and a body.
+
+- #### FrameLayout
+
+This layout is used to create a GUI that includes a classic app bar, a bottom navigation bar, and a body.
+
+### Content Layouts
+
+Content layouts are used to display dynamic data and content within the GUI. Currently, there is only one content layout provided by this package:
+
+- #### GridLayout
+
+This layout is used to display data and content in a grid layout.
+
+### Installation
+
+To use Wyatt UI Layout in your Flutter project, add the following dependency to your pubspec.yaml file:
+
+```yaml
+wyatt_ui_layout:
+  git:
+    url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
+    path: packages/wyatt_ui_layout
+```
+
+That's it! You're now ready to use Wyatt UI Layout in your project.
-- 
2.47.2