fix(README): better descriptions (#2)

README.md

@@ -1,6 +1,6 @@
-# Simple extension for managing actions token in Keycloak
+# Keycloak actions token
 
-This PoC extension exposes a custom realm resource to manage action tokens.
+This extension exposes a custom realm resource to manage action tokens in keycloak.
 
 ## Build the example
 ```
@@ -24,17 +24,25 @@ Request an action token for a set of specific actions.
 | Type | Name | Required | Description | Schema |
 | :----: | --- | --- | --- | --- |
 | Path | realm | true | realm name (not id!) | string |
-| Body | user_id | true | User id | string |
-| Body | actions | true | required actions the user needs to complete | < string > array |
+| Body | user_id | true | User that will be asked to perform a set of required actions | string |
+| Body | actions | true | Required actions the user needs to complete. List of [required actions here](https://www.keycloak.org/docs-api/16.0/javadocs/org/keycloak/models/UserModel.RequiredAction.html) | < string > array |
 | Body | lifespan | false | Number of seconds after which the generated token expires | integer(int32) |
-| Body | client_id | false | Client id | string |
-| Body | redirect_uri | false | Redirect uri | string |
-| Body | redirect_uri_validate | false | Validate redirect uri | string |
+| Body | client_id | false | OAuth client the token was issued for. Defaults to the `account` client. | string |
+| Body | redirect_uri | false | If no redirect is given, then there will be no link back to click after actions have completed. Redirect uri must be a valid uri for the particular `client_id` | string |
+| Body | redirect_uri_validate | false | Bypass `redirect_uri` validation checks for the particular `client_id` | boolean |
 #### Response
 | Type | Name | Required | Description | Schema |
 | :----: | --- | --- | --- | --- |
-| Body | action_token | true | JWT action token | string |
+| Body | action_token | true | JWT action token signed with the realm's default signature algorithm | string |
 #### Consumes
 - `application/json`
 #### Produces
 - `application/json`
+
+## Useful resources
+- https://github.com/aerogear/keycloak-metrics-spi
+- https://github.com/thomasdarimont/keycloak-avatar-minio-extension
+- https://github.com/keycloak/keycloak-quickstarts/tree/latest/action-token-authenticator
+- https://www.janua.fr/action-token-in-keycloak/
+- https://stackoverflow.com/questions/67006007/how-to-generate-and-use-login-action-token-for-keycloak-user-update-profile-in-e
+- https://github.com/keycloak/keycloak/blob/264c5a6cdb2fb86e20536ea4302d20160ca01919/services/src/main/java/org/keycloak/services/resources/admin/UserResource.java#L826