From 753285b84fc82baa6d92f119179fa9e11f7369a1 Mon Sep 17 00:00:00 2001 From: Romain Bioteau Date: Mon, 5 Oct 2020 15:20:19 +0200 Subject: [PATCH] doc(README): update readme --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74a1c92..15a561d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -28,7 +31,7 @@ mvn archetype:generate \ -DdisplayName="My Theme" ``` -### Optionnal archetype parameters +### Optional archetype parameters | Parameter | Required | Default value | Description |