Skip to content

Commit 46aa789

Browse files
authored
Merge pull request #47 from LoganGray/master
small typos fixes and minor grammar changes for clarity
2 parents a5e7b50 + 68bd3ff commit 46aa789

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
## Introduction
44

5-
An intelligent code generator for Laravel framework that will save you time! This awesome tool will help you generate resources like views, controllers, routes, migrations, languages and/or form-requests! It is extremely flexible and customizable to cover many on the use cases. It is shipped with cross-browsers compatible template, along with a client-side validation to modernize your application.
5+
An intelligent code generator for Laravel framework that will save you time! This awesome tool will help you generate resources like views, controllers, routes, migrations, languages and/or form-requests! It is extremely flexible and customizable to cover many use cases. It is shipped with a cross-browser compatible template, along with client-side validation to modernize your application.
66

7-
For full documentation and live demo please visit <a href="https://crestapps.com/laravel-code-generator/docs/2.2" target="_blank" title="Laravel Code Generator Documentation">CrestApps.com</a>
7+
For full documentation and live demo, please visit <a href="https://crestapps.com/laravel-code-generator/docs/2.2" target="_blank" title="Laravel Code Generator Documentation">CrestApps.com</a>
88

99
## Features
1010

1111
<ul>
1212
<li>Create very clean, reusable and highly readable code to build on.</li>
1313
<li>Create full resources using a single command with <strong>migration</strong> or from <strong>existing database</strong>.</li>
1414
<li>Creates full resources for all of the existing tables in the database using one command.</li>
15-
<li>Allows you to save the fields in a JSON file and recreate resources when the business needs changes.</li>
15+
<li>Allows you to save the fields in a JSON file and recreate resources when the business needs change.</li>
1616
<li>Utilizes JSON based resource-file to allow you to define your resources. Resource-file allows you to easily regenerate the resource at any time even when the business rules change.</li>
1717
<li>Create standard CRUD controllers with simple or form-request validation.</li>
1818
<li>Customizable view’s templates to enable you to change the standard look and feel of your application.</li>
1919
<li>Create model with relations.</li>
2020
<li>Create named routes with and without group.</li>
2121
<li>Create standard CRUD views.</li>
2222
<li>Smart migration engine! Keeps track of all generated migrations to only create the needed migration.</li>
23-
<li>Intelligent enough to automatically handles the relations between the models.</li>
23+
<li>Intelligent enough to automatically handle the relations between the models.</li>
2424
<li>Very flexible and rich with configurable options.</li>
2525
<li>Easy commands to create resource-file; additionally, add or reduce existing resource-file.</li>
26-
<li>Full capability to generate multi-languages applications.</li>
26+
<li>Full capability to generate multi-language applications.</li>
2727
<li>Client-side validation.</li>
2828
<li>File uploading handling.</li>
2929
<li>Auto store multiple-response in the database.</li>
@@ -38,7 +38,7 @@ For full documentation and live demo please visit <a href="https://crestapps.com
3838

3939
## Installation
4040

41-
1. To download this package into your laravel project, use the command-line to execute the following command
41+
1. To download this package into your laravel project, use the command-line to execute the following command:
4242

4343
```
4444
composer require crestapps/laravel-code-generator --dev
@@ -60,7 +60,8 @@ For full documentation and live demo please visit <a href="https://crestapps.com
6060
php artisan vendor:publish --provider="CrestApps\CodeGenerator\CodeGeneratorServiceProvider" --tag=default
6161
```
6262

63-
> A layout is required for the default views! The code generator allows you to create a layout using the command-line. Of cource you can use your own layout. You'll only need to include [CSS bootstrap framework](http://getbootstrap.com/ "CSS bootstrap framework") in your layout for the default templates to work properly. Additionally, you can chose to you design your own templetes using a different or no css framework.
63+
64+
> A layout is required for the default views! The code generator allows you to create a layout using the command-line. Of course, you can use also your own layout. You'll only need to include [CSS bootstrap framework](http://getbootstrap.com/ "CSS bootstrap framework") in your layout for the default templates to work properly. Additionally, you can chose to design your own templetes using a different framework or css.
6465
6566
## Lessons
6667
Checkout our channel on <a href="https://www.youtube.com/channel/UCkEd0nOoRf3o0ahspAu7Y9w/videos" target="_blank" title="CrestApps YouTube Channel">YouTube.com</a>
@@ -128,11 +129,11 @@ Checkout our channel on <a href="https://www.youtube.com/channel/UCkEd0nOoRf3o0a
128129
## Contribution
129130
Do you like this project and want to contribute?
130131
- Please start by *Staring* this package on GitHub.
131-
- Sharing this projects with others is your way of saying keep improvements and new awesome feature coming.
132+
- Sharing this projects with others is your way of saying keep the improvements and new awesome features coming.
132133
- Report any bugs or send us any comments, idea, thought that you may have about this project as an issue on GitHub.
133134

134135
## What did you create with this package?
135-
I'd love to know if your site was generated using this package and list your logo on the documentation site. Please email using my contact info found in `composer.json` file.
136+
I'd love to know if your site was generated using this package and list your logo on the documentation site. Please email me by using my contact info found in `composer.json` file.
136137

137138
## Examples
138139

@@ -148,7 +149,7 @@ The following example assumes that we are trying to create a CRUD called <var>As
148149

149150
<blockquote>
150151
<p><code>php artisan resource-file:create AssetCategory --fields=id,name,description,is_active</code></p>
151-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
152+
<p><small>The above command will create a resource-file named <code>asset_categories</code>, and will save it here <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
152153
<p><code>php artisan create:resources AssetCategory --with-migration</code></p>
153154
<p><small>The above command will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views, the routes, and migration class!</var></small></p>
154155
</blockquote>
@@ -158,7 +159,7 @@ The following example assumes that we are trying to create a CRUD called <var>As
158159

159160
<blockquote>
160161
<p><code>php artisan resource-file:create AssetCategory --fields=id,name,description,is_active --translation-for=en,ar</code></p>
161-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
162+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
162163
<p><code>php artisan create:resources AssetCategory --with-migration</code></p>
163164
<p><small>The above command will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views, the routes, and migration class!</var></small></p>
164165
</blockquote>
@@ -167,7 +168,7 @@ The following example assumes that we are trying to create a CRUD called <var>As
167168

168169
<blockquote>
169170
<p><code>php artisan resource-file:create AssetCategory --fields=id,name,description,is_active</code></p>
170-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
171+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
171172
<p><code>php artisan create:resources AssetCategory --with-form-request</code></p>
172173
<p><small>The above command will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views, the routes, and <var>app/Http/Requests/AssetCategoriesFormRequest</var> class!</var></small></p>
173174
</blockquote>
@@ -176,7 +177,7 @@ The following example assumes that we are trying to create a CRUD called <var>As
176177

177178
<blockquote>
178179
<p><code>php artisan resource-file:create AssetCategory --fields=id,name,description,is_active</code></p>
179-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
180+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
180181
<p><code>php artisan create:resources AssetCategory --with-soft-delete --with-migration</code></p>
181182
<p><small>The above command will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views, the routes, and migration file!</var></small></p>
182183
</blockquote>
@@ -185,29 +186,29 @@ The following example assumes that we are trying to create a CRUD called <var>As
185186

186187
<blockquote>
187188
<p><code>php artisan create:resources AssetCategory --table-exists</code></p>
188-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var>. It is going to assume that the table name is called "asset_categories" in your database. If that is not the case, you can use <var>--table-name=some_other_table_name</var></small></p>
189+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var>. It is going to assume that the table name is called "asset_categories" in your database. Note, it assumes your table is plural. If that is not the case, you can use <var>--table-name=some_other_table_name</var></small></p>
189190

190-
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and the routes!</var></small></p>
191-
<p><small>You may also create a resource-file from existing database separately using <code>php artisan resource-file:form-database AssetCategory</code></small></p>
191+
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and routes!</var></small></p>
192+
<p><small>You may also create a resource-file from existing database separately using <code>php artisan resource-file:from-database AssetCategory</code></small></p>
192193
</blockquote>
193194

194195

195196
### Creating resources from existing database with translation for English and Arabic
196197

197198
<blockquote>
198199
<p><code>php artisan create:resources AssetCategory --translation-for=en,ar --table-exists</code></p>
199-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
200+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
200201
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and the routes!</var></small></p>
201-
<p><small>You may also create a resource-file from existing database separately using <code>php artisan resource-file:form-database AssetCategory --translation-for=en,ar</code></small></p>
202+
<p><small>You may also create a resource-file from existing database separately using <code>php artisan resource-file:from-database AssetCategory --translation-for=en,ar</code></small></p>
202203
</blockquote>
203204

204205
### Creating resources from existing database with translation for English and Arabic in two step for better control over the fields!
205206

206207
<blockquote>
207-
<p><code>php artisan resource-file:form-database AssetCategory --translation-for=en,ar</code></p>
208+
<p><code>php artisan resource-file:from-database AssetCategory --translation-for=en,ar</code></p>
208209
<p><code>php artisan create:resources AssetCategory</code></p>
209-
<p><small>The above command will create resource-file names <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
210-
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and the routes!</var></small></p>
210+
<p><small>The above command will create resource-file named <var>/resources/laravel-code-generator/sources/asset_categories.json</var></small></p>
211+
<p><small>Then it will create a model <var>app/Models/AssetCategory</var>, a controller <var>app/Http/Controllers/AssetCategoriesController, all views and routes!</var></small></p>
211212
</blockquote>
212213

213214

0 commit comments

Comments
 (0)