Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
garronej committed Sep 20, 2024
1 parent 497bf2d commit e0cf7a4
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,13 @@ This project re-packages [`@keycloak/keycloak-account-ui`](https://www.npmjs.com
All credits goes to the keycloak team for the original work. Mainly [@jonkoops
](https://github.com/jonkoops) and [@edewit](https://github.com/edewit).

This re-packaged distribution exists to make it possible to take ownership of
some specific part of the Account UI to create your own custom version of it.
In straight forward therms it make the Account UI ejectable, you can copy
past [the source files](https://unpkg.com/browse/@keycloakify/[email protected]/src/) that you want to modify into your codebase.
This re-packaged distribution serves two key purposes:

1. **Ensuring retro-compatibility with Keycloak**:
It allows the Account UI to work seamlessly with older versions of Keycloak (down to version 19) and future major versions. This enables you to create a custom Account UI with minimal maintenance, without worrying about which Keycloak version it will be deployed on.

2. **Enabling partial customization of the Account UI**:
You can take ownership of specific parts of the Account UI by simply copying and modifying [source files](https://unpkg.com/browse/@keycloakify/[email protected]/src/) as needed. The rest of the UI can remain in the original module, so your codebase will only include the files you've customized.

For more details on integrating this package into your project, refer to the [Keycloakify documentation](https://keycloakify.dev).

Expand Down

0 comments on commit e0cf7a4

Please sign in to comment.