Skip to content

Commit

Permalink
doc(README): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rbioteau committed Oct 5, 2020
1 parent 10b9d43 commit 753285b
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@

# bonita-theme-archetype

[short description and link to the documentation]
This project contains a maven archetype, which allow to easily setup a Bonita theme project.
A theme project is node project wrapped in a maven project that uses:
* [maven-frontend-plugin](https://github.com/eirslett/frontend-maven-plugin) to setup node and npm binaries
* [node-sass](https://www.npmjs.com/package/node-sass) and [bootstrap-sass](https://www.npmjs.com/package/bootstrap-sass) to create your Bootstrap 3 theme using [sass](https://sass-lang.com/)

## How to build the archetype

Expand All @@ -28,7 +31,7 @@ mvn archetype:generate \
-DdisplayName="My Theme"
```

### Optionnal archetype parameters
### Optional archetype parameters


| Parameter | Required | Default value | Description |
Expand Down

0 comments on commit 753285b

Please sign in to comment.