readme changes

Author: Jonathan

README.md

@@ -1,25 +1,31 @@
 # Crud Generator Laravel 9 and 10 (your time saver)
 
-Crud Generator Laravel is a package that you can integrate in your Laravel to create a REAL CRUD :
-- **controller** with all the code already written
-- **views** (index, create, edit, show)
-- **model** with relationships
-- **request** file with rules
-- **migration** file
+Crud Generator Laravel is a package designed to simplify the creation of a complete CRUD system in your Laravel project. It includes:
+
+- **Controller** with all the code already written
+- **Views** (index, create, edit, show)
+- **Model** with relationships
+- **Request** file with validation rules
+- **Migration** file
 
 And since 1.9.2, a complete **REST API** !
 
+[ NEW ] [Your voice matters! Participate in the polls and vote for future features and improvements](https://github.com/misterdebug/crud-generator-laravel/discussions/categories/polls)
+
+
 ## Installation
 
-1\. Run composer command:
+1\. Run the following composer command:
 
-``` composer require mrdebug/crudgen --dev```
+``` composer require mrdebug/crudgen --dev ```
 
 2\. If you don't use Laravel Collective Form package in your project, install it:
 
-``` composer require laravelcollective/html ``` <sub>not required if you don't need views</sub>
+``` composer require laravelcollective/html ```
+
+<sub>(Note: This step is not required if you don't need views.)</sub>
 
-3\. Publish config file and default-theme directory for views
+3\. Publish the configuration file and the default-theme directory for views:
 
 ``` php artisan vendor:publish --provider="Mrdebug\Crudgen\CrudgenServiceProvider" ```
 
@@ -28,37 +34,37 @@ And since 1.9.2, a complete **REST API** !
 
 ### Create CRUD (or REST API)
 
-Let's make a real life example : Build a blog
+Let's illustrate with a real life example : Building a blog
 
 A `Post` has many (hasMany) `Comment` and belongs to many (belongsToMany) `Tag`
 
 A `Post` can have a `title` and a `content` fields
 
 Let's do this 🙂
 
-<small>You need a REST API instead of a CRUD ? [Read this wiki](https://github.com/misterdebug/crud-generator-laravel/wiki/Make-a-complete-REST-API-instead-of-CRUD)</small>
+<sub>If you need a REST API instead of CRUD, [read this wiki](https://github.com/misterdebug/crud-generator-laravel/wiki/Make-a-complete-REST-API-instead-of-CRUD)</sub>
 
 #### CRUD generator command :
 
 ``` php artisan make:crud nameOfYourCrud "column1:type, column2" ``` (theory)
 
 ``` php artisan make:crud post "title:string, content:text" ``` (for our example)
 
-<small>[Available options](https://github.com/misterdebug/crud-generator-laravel/wiki/Available-options-when-you-use-make:crud-command)</small>
+<sub>[Available options](https://github.com/misterdebug/crud-generator-laravel/wiki/Available-options-when-you-use-make:crud-command)</sub>
 
-When you call this command, controller, views and request are generated with your fields (here: title and content).
+When you call this command, the controller, views and request are generated with your fields (in this case, title and content).
 ![image](https://user-images.githubusercontent.com/23297600/192172786-1703f7b8-f577-45c1-b0f9-296999827af2.png)
 
 Now let's add our relationships (`Comment` and `Tag` models) :
 
 ![image](https://user-images.githubusercontent.com/23297600/192173041-6c71d727-1e29-4edc-9397-bdb07f44a378.png)
 
-We add an `hasMany` relationship between our `Post` and `Comment`
+We add a `hasMany` relationship between our `Post` and `Comment`
 and a `belongsToMany` with `Tag`
 
-If you look good, two migrations are created (`create_posts` AND `create_post_tag`).
+Two migrations are created (`create_posts` AND `create_post_tag`).
 
-`create_posts` will be your table for your `Post` model
+`create_posts` is your table for your `Post` model
 
 `create_post_tag` is a pivot table to handle the `belongsToMany` relationship
 
@@ -80,7 +86,7 @@ A controller file is created in your **app/Http/Controllers** directory. All met
 
 To create your routes for this new controller, you can do this :
 
-``` Route::resource('posts', PostsController::class); ``` <small>(don't forget to import your `PostsController` in your `web.php` file)</small>
+``` Route::resource('posts', PostsController::class); ``` <sub><sup>(don't forget to import your `PostsController` in your `web.php` file)</sup></sub>
 
 ##### Screenshots
 
@@ -91,7 +97,7 @@ To create your routes for this new controller, you can do this :
 `/posts` :
 ![image](https://user-images.githubusercontent.com/23297600/192176845-b3722083-90a9-4257-90d1-8a2eb28baa01.png)
 
-You can `edit` and `delete` too your new post. And a `show` page is created too 🙂
+You can `edit` and `delete` your new post. And a `show` page is created too 🙂
 
 ### Request
 
@@ -100,7 +106,7 @@ A request file is created in your **app/Http/Requests** directory. By default, a
 ### Views
 
 A views directory is created in your **resources/views** directory.
-<sub>You want to customize generated views ? [https://github.com/misterdebug/crud-generator-laravel/wiki/Custom-your-views](https://github.com/misterdebug/crud-generator-laravel/wiki/Custom-your-views)</sub>
+<sub>If you want to customize generated views : [https://github.com/misterdebug/crud-generator-laravel/wiki/Custom-your-views](https://github.com/misterdebug/crud-generator-laravel/wiki/Custom-your-views)</sub>
 
 You can create views independently of the CRUD generator with :
 ``` php artisan make:views nameOfYourDirectoryViews "column1:type, column2" ```
@@ -122,13 +128,13 @@ Finished 🎉
 
 ## Remove a CRUD
 
-You can delete all files (except migrations) created by the `make:crud` command at any time (you don't need to remove all files by hand)
+You can delete all files (except migrations) created by the `make:crud` command at any time. No need to remove files manually :
 
 ``` php artisan rm:crud nameOfYourCrud --force ```
 
 ``` php artisan rm:crud post --force ``` (in our example)
 
---force (optional) can delete all files without confirmation
+The `--force` flag (optional) deletes all files without confirmation
 
 ![image](https://user-images.githubusercontent.com/23297600/192183601-a4f8d206-3920-4f8a-8e0d-cf8442894e07.png)