Skip to content

Commit 8928947

Browse files
committed
Add installation and usage section
1 parent be90366 commit 8928947

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,31 @@ Follow along with the development of Blueprint by [watching live streams](https:
55

66
_**v0.1 Tagged**: A beta release of Blueprint is now available which supports generating components using `models` definitions._
77

8+
9+
## Installation
10+
You can install this package via composer using this command:
11+
12+
```sh
13+
composer require --dev laravel-shift/blueprint
14+
```
15+
16+
The package will automatically register itself.
17+
18+
19+
## Usage
20+
Blueprint adds an artisan command.
21+
22+
```sh
23+
php artisan blueprint:build [draft]
24+
25+
```
26+
27+
The `draft` file contains your definition of the components to generate. By default, the `blueprint:build` command automatically loads a `draft.yaml` file.
28+
29+
830
---
931

32+
1033
**Example Syntax**
1134
```yaml
1235
models:

0 commit comments

Comments
 (0)