improve docs

This commit is contained in:
Joseph Garrone
2021-02-27 18:19:02 +01:00
parent 06bc126584
commit f70625bf3f
2 changed files with 7 additions and 6 deletions

View File

@ -11,7 +11,7 @@
<img src="https://img.shields.io/npm/l/keycloak-react-theming">
</p>
# MOTIVATION
# Motivations
The problem:
@ -74,7 +74,8 @@ and a `static/` directory generated by webpack.
**All this is defaults with [`create-react-app`](https://create-react-app.dev)** (tested with 4.0.3=)
- For building the theme: `mvn` (Maven) must be installed
- For development, (testing the theme in a local container ): `rm`, `mkdir`, `wget`, `unzip` are assumed to be available.
- For development, (testing the theme in a local container ): `rm`, `mkdir`, `wget`, `unzip` are assumed to be available
and `docker` up and running.
NOTE: This build tool has only be tested on MacOS.
@ -87,7 +88,7 @@ Part of the lib that runs with node, at build time.
- `npx build-keycloak-theme`: Builds the theme, the CWD is assumed to be the root of your react project.
- `npx download-sample-keycloak-themes`: Downloads the keycloak default themes (for development purposes)
## The fronted lib ( imported into your react
## The fronted lib ( imported into your react app )
Part of the lib that you import in your react project and runs on the browser.