docs: update readme

This commit is contained in:
Hugo Pointcheval 2023-01-21 16:00:52 +01:00
parent 908611d32d
commit 3d5f10c5cf
Signed by: hugo
GPG Key ID: 3AAC487E131E00BC
2 changed files with 28 additions and 18 deletions

View File

@ -1,10 +1,7 @@
name: wyatt_feature_brick
description: New feature brick including state mananement
version: 0.1.0+1
environment:
mason: ">=0.1.0-dev.26 <0.1.0"
version: 0.1.1
vars:
feature_name:

View File

@ -1,23 +1,31 @@
A sample command-line application to generate which allows to generate the template of a brick from a project which compiles.
# Dart - Brick Generator
A simple command-line application which allows to generate the template of a brick from a project which compiles.
With an entrypoint in `bin/`, library code in `lib/`.
# How to use
## How to use
- Add your app in `apps`.
- Add `brick_config.yaml` in you app folder and add this fields :
- Add your app in `apps/`.
- Add `brick_config.yaml` in you app folder and add this fields:
> Here we have created `wyatt_feature_brick` app in `apps/`
```yaml
brick_name: wyatt_feature_brick
name: wyatt_feature_brick
description: New feature brick including state mananement
path_to_brickify: lib/feature_name
path_to_brickify: lib/feature_brick_folder
version: 0.1.1
variables:
feature_brick:
variable_name: feature_brick
vars:
feature_name:
type: string
isBloc:
variable_name: bloc
type: bool
name: feature_name
description: Name of the feature
default: Dash
prompt: What is the name of your new feature
```
then run command with project path
@ -26,5 +34,10 @@ then run command with project path
dart tools/brick_generator/bin/brick_generator.dart ./apps/wyatt_feature_brick
```
# TODO
- Work on bool variables
## TODO
- [ ] bool variables
- [ ] enum variables
- [ ] array variables
- [ ] pre hooks
- [ ] post hooks