Update README.md

README.md

@@ -1,2 +1,29 @@
 # apple-identity-provider-keycloak
 An extension for Keycloak, that enables web-based sign in with Apple and token exchange
+
+## Overview
+The Apple Identity Provider for Keycloak is a Keycloak extension designed to seamlessly integrate Apple Sign In authentication into applications utilizing Keycloak as the identity provider. With this extension, users can leverage their Apple ID credentials for a secure and streamlined login experience.
+
+## Features
+- Apple Sign In Integration: Enable Apple Sign In as an authentication method within your Keycloak instance.
+- OAuth 2.0 Compatibility: Ensures seamless compatibility with the OAuth 2.0 protocol for secure and standardized authentication.
+- User Attributes: Retrieve and map user attributes from Apple ID to Keycloak user profiles.
+- Easy Configuration: Effortlessly set up the extension using the Keycloak admin console.
+
+## Prerequisites
+- Keycloak 12.0.0 or later
+- Apple Developer Account
+- Apple Services Identifier and Key
+
+## Contributing
+Contributions are highly welcomed! If you encounter issues or have ideas for improvements, please open an issue or submit a pull request following the standard GitHub workflow.
+
+## License
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+Special thanks to the Keycloak community and contributors for enhancing identity management capabilities and making this extension possible.
+
+## Contact
+For questions, feedback, or support, please open an issue on the GitHub repository.
+