Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bensherred committed Aug 31, 2024
1 parent 67c9edb commit 19fbf1e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 25 deletions.
41 changes: 17 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,37 @@
# Fabricate
<p align="center"><img src="/art/logo.svg" height="68" alt="Fabricate"></p>

[![Latest Version on Packagist](https://img.shields.io/packagist/v/red-explosion/fabricate.svg?style=flat-square)](https://packagist.org/packages/red-explosion/fabricate)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/red-explosion/fabricate/tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/red-explosion/fabricate/actions/workflows/tests.yml?query=branch:main)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/red-explosion/fabricate/coding-standards.yml?label=code%20style&style=flat-square)](https://github.com/red-explosion/fabricate/actions/workflows/coding-standards.yml?query=branch:main)
[![Total Downloads](https://img.shields.io/packagist/dt/red-explosion/fabricate.svg?style=flat-square)](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
Expand Down
1 change: 1 addition & 0 deletions art/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 19fbf1e

Please sign in to comment.