diff --git a/README.md b/README.md index 898ccaf..7d92f78 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,11 @@ A starter/demo project for [Keycloakify](https://keycloakify.dev) -> NOTE: If you are only looking to create a theme and don't care about integrating it into an React app there -> are a lot of things that you can remove from this starter. [Please read this](#standalone-keycloak-theme). +# Introduction + +This repo constitutes an easily reusable setup for a standalone Keycloak theme project OR for a SPA React App that generates a +Keycloak theme that goes along with it. +If you are only looking to create a theme (an not a theme + an App) there are a lot of things that you can remove from this starter: [Please read this](#standalone-keycloak-theme). # Quick start @@ -23,11 +26,6 @@ yarn build-keycloak-theme # your theme on a real Keycloak instance. ``` -# Introduction - -This repo constitutes an easily reusable CI setup for SPA React App that generates Keycloaks's theme -using [keycloakify](https://github.com/InseeFrLab/keycloakify). - # The CI workflow - You need to manually allow GitHub Action to push on your REPO. For this reason the initial setup will fail. You need to enabled permission and re-run failed job: [see video](https://user-images.githubusercontent.com/6702424/213480604-0aac0ea7-487f-491d-94ae-df245b2c7ee8.mov).