diff --git a/README.md b/README.md index 1e26a0c..f89b6a2 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,15 @@ Not applicable. ## Documentation -For details see [Theme section](https://www.keycloak.org/docs/latest/server_development/#_themes) of Keycloak develover docs. +For details see [Theme section](https://www.keycloak.org/docs/latest/server_development/#_themes) of Keycloak developer docs. -As specified in [Deploying Themes](https://www.keycloak.org/docs/latest/server_development/#deploying-themes) section of documentation, *themes can be deployed to Keycloak by copying the theme directory to themes or it can be deployed as an archive.* +As specified in [Deploying Themes](https://www.keycloak.org/docs/latest/server_development/#deploying-themes) section of the documentation, *themes can be deployed to Keycloak by copying the theme directory to themes or it can be deployed as an archive.* -In a future release of this project, when themes have been full tested, it will be implemented a script to build themes archive. For now to deploy themes in a Keycloak we are applying the first approach. +In a future release of this project, when themes have been fully tested, a script to build a themes archive will be developed. Currently, in order to deploy themes in a Keycloak instance, the first approach is applied. -In development phase you have to disable themes caching in Keycloak configuration file first. To do this edit `standalone.xml`. For `theme` set `staticMaxAge` to `-1` and both `cacheTemplates` and `cacheThemes` to `false`. +During the development phase, themes caching in Keycloak configuration file has to be disabled. To do this edit `standalone.xml`. For `theme` set `staticMaxAge` to `-1` and both `cacheTemplates` and `cacheThemes` to `false`. -Then we suggest to clone this repo somewhere and create a symbolic link for each theme you want to deploy: +At this point it is suggested to clone this repo somewhere and create a symbolic link for each theme you want to deploy: mkdir /opt/git cd /opt/git @@ -35,7 +35,7 @@ Then we suggest to clone this repo somewhere and create a symbolic link for each ln -s /opt/git/d4science-keycloak-themes/src/themes/dev4.d4science.org/ ln -s /opt/git/d4science-keycloak-themes/src/themes/next.d4science.org/ -If you was logged-in in Keycloak administration console already you have to logout them re-login. Then you can set one of the new themes per Keycloak Realm or for a specific Keycloak Client in the realm. +If you are already logged-in in Keycloak administration console you have to logout and then re-login. At that you can set one of the new themes per Keycloak Realm or for a specific Keycloak Client in the realm. ## Change log