[](https://packagist.org/packages/red-explosion/fabricate)
[](https://github.com/red-explosion/fabricate/actions/workflows/tests.yml?query=branch:main)
[](https://github.com/red-explosion/fabricate/actions/workflows/coding-standards.yml?query=branch:main)
[](https://packagist.org/packages/red-explosion/fabricate)
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+## Introduction
-## Installation
-
-You can install the package via composer:
+After creating multiple projects over the years, we found that we were repeating the same steps over and over again.
+Install these packages, add these files, delete the files etc. and it got to a point where it became tedious. That's
+where Fabricate comes in.
-```bash
-composer require red-explosion/fabricate
-```
+Fabricate is an opinionated yet flexible package for building Laravel applications. It installs a number of recommended
+packages, publishes stub files (such as architecture tests) and much more. Fabricate is designed to work with a blank
+Laravel or any of the official starter kits.
-You can publish and run the migrations with:
+## Installation
-```bash
-php artisan vendor:publish --tag="fabricate-migrations"
-php artisan migrate
-```
+First, you should [create a new Laravel application](https://laravel.com/docs/11.x/installation). Fabricate is designed
+to work with any of the Laravel starter kits or a blank Laravel application.
-You can publish the config file with:
+Once you have created a new Laravel application, you will need to install Fabricate using Composer:
```bash
-php artisan vendor:publish --tag="fabricate-config"
+composer require red-explosion/fabricate
```
-Optionally, you can publish the views using
+After Composer has installed the Fabricate package, you should run the `fabricate:install` Artisan command. This
+command installs additional packages, publishes stubs and fixes any linting errors. Fabricate publishes all of its code
+to your application so that you have full control and visibility over its features and implementation.
```bash
-php artisan vendor:publish --tag="fabricate-views"
-```
-
-## Usage
-
-```php
-$variable = new RedExplosion\Fabricate();
-echo $variable->echoPhrase('Hello, Red Explosion!');
+php artisan fabricate:install
```
## Testing
diff --git a/art/logo.svg b/art/logo.svg
new file mode 100644
index 0000000..da44cb8
--- /dev/null
+++ b/art/logo.svg
@@ -0,0 +1 @@
+
diff --git a/composer.json b/composer.json
index 9748c3e..0cf27ce 100644
--- a/composer.json
+++ b/composer.json
@@ -1,6 +1,6 @@
{
"name": "red-explosion/fabricate",
- "description": "An opionated yet flexible package for scaffolding new Laravel applications.",
+ "description": "An opinionated yet flexible package for scaffolding new Laravel applications.",
"license": "MIT",
"homepage": "https://github.com/red-explosion/fabricate",
"type": "library",
