Update Readme

This commit is contained in:
garronej
2023-03-21 23:40:16 +01:00
parent cee8ea7ecb
commit e379043ed2
2 changed files with 5 additions and 3 deletions

View File

@ -10,14 +10,15 @@
<a href="https://starter.keycloakify.dev/storybook">Keycloak theme Storybook</a>
</p>
# 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 (and not a theme + an App) there are a lot of things that you can remove from this starter: [Please read this section of the README](#standalone-keycloak-theme).
❗️ WARNING ❗️: Don't waste time trying to setup Keycloakify in a [Vite](https://vitejs.dev/) project.
Currently Keycloakify only works with Webpack. If you want Vite support [join the conversation](https://github.com/InseeFrLab/keycloakify/issues/271#issuecomment-1478242786).
# Quick start
```bash