Merge pull request #872 from walt-id/readme-update

README: update links & architecture img

README.md

@@ -28,8 +28,10 @@ Available for Kotlin/Java and JavaScript environments.
   implementation of the OID4VCI and OIDC4VP protocols.
 - **SD-JWT** ([GitHub](https://github.com/walt-id/waltid-identity/tree/main/waltid-libraries/sdjwt/waltid-sdjwt)) -
   create and verify Selective Disclosure JWTs.
+- **Ktor-Authnz** ([GitHub](https://github.com/walt-id/waltid-identity/tree/main/waltid-libraries/auth/waltid-ktor-authnz)) - Add various authentication methods (OIDC, Email/Password, ...) to Ktor projects.
+- **Permissions** ([GitHub](https://github.com/walt-id/waltid-identity/tree/main/waltid-libraries/auth/waltid-permissions)) - Enable fine-grained authorisation patterns in applications with waltid-permissions.
 
-### Services
+### REST Services
 
 A set of APIs to build issuer, verifier, and wallet capabilities into any app.
 
@@ -44,27 +46,42 @@ A set of APIs to build issuer, verifier, and wallet capabilities into any app.
 
 A set of white-label apps to get started in no time.
 
-- [Web-Wallet](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-web-wallet) - A custodial web-wallet (PWA)
-  solution for credentials and tokens.
-- [Portal](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-web-portal) - An issuer and verifier portal for
-  credentials, which are managed [here](https://github.com/walt-id/waltid-credentials).
+- **Web-Wallets** ([Demo](https://wallet.walt.id/login) | [Docs](https://docs.walt.id/community-stack/wallet/apps/web-wallet/overview) | [GitHub](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-web-wallet)) - Custodial web-wallet (PWA) solutions for credentials and tokens.
+- **Portal** ([Demo](https://portal.walt.id/) | [Docs](https://docs.walt.id/community-stack/issuer/apps/portal/overview) | [GitHub](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-web-portal)) - An issuer and verifier portal for credentials, which are managed [here](https://github.com/walt-id/waltid-credentials).
 
-## Use Services And Apps
 
-Use the [walt.id identity package](https://github.com/walt-id/waltid-identity/tree/main/docker-compose) to run all APIs and Apps with
-docker:
+## Use REST Services And Apps
+
+Use the [walt.id identity package](https://github.com/walt-id/waltid-identity/tree/main/docker-compose) to run all APIs and Apps with docker:
+
+**Clone walt.id identity**
+
+```bash
+git clone https://github.com/walt-id/waltid-identity.git && cd waltid-identity
+```
+
+**Launch the services**
 
 ```bash
-cd docker-compose && docker-compose up
+cd docker-compose && docker compose up
 ```
 
-Learn more about the exposed ports [here](https://github.com/walt-id/waltid-identity/tree/main/docker-compose).
+Learn more about the docker settings & exposed ports [here](https://github.com/walt-id/waltid-identity/tree/main/docker-compose).
 
 ## Use the Command Line Tool
 
-Use the [walt.id CLI](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-cli) to run the core functions from
+Use the [walt.id CLI](https://github.com/walt-id/waltid-identity/tree/main/waltid-applications/waltid-cli) to run the
+core functions from
 the command line. Make sure you have your Java Runtime set up.
 
+**Clone walt.id identity**
+
+```bash
+git clone https://github.com/walt-id/waltid-identity.git && cd waltid-identity
+```
+
+**Access CLI**
+
 ```bash
 cd waltid-applications/waltid-cli && ./waltid-cli.sh
 ```
@@ -74,15 +91,12 @@ cd waltid-applications/waltid-cli && ./waltid-cli.sh
 The walt.id identity repo is part of The Community Stack, walt.id's collection of open-source products to build identity and wallet
 solutions. Learn more [here](https://walt.id/blog/p/community-stack).
 
-![waltid-identity-architecture](https://github.com/user-attachments/assets/0400118b-3a38-421e-91dc-7293f6a44b6c)
+![waltid-identity-architecture](https://github.com/user-attachments/assets/98c020fe-dc37-46fd-9886-613ee8fc8760)
 
 ## Join the community
 
-* Connect and get the latest updates: <a href="https://discord.gg/AW8AgqJthZ">Discord</a> | <a href="https://walt.id/newsletter">
-  Newsletter</a> | <a href="https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA">
-  YouTube</a> | <a href="https://mobile.twitter.com/walt_id" target="_blank">Twitter</a>
-* Get help, request features and report bugs: <a href="https://github.com/walt-id/.github/discussions" target="_blank">GitHub
-  Discussions</a>
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
 
 ## License
 

waltid-applications/waltid-android/README.md

@@ -1,16 +1,24 @@
-# WALT ID Android Sample Project
-
-This project showcases the capabilities of the WALT ID library, demonstrating how to create keys, sign text, create DIDs (Decentralized Identifiers), and verify signed content.
+<div align="center">
+ <h1>Android Sample Project</h1>
+ <span>by </span><a href="https://walt.id">walt.id</a>
+ <p>Sample project showcasing key & DID creation, text signing, and signed content verification.<p>
+
+<a href="https://walt.id/community">
+<img src="https://img.shields.io/badge/Join-The Community-blue.svg?style=flat" alt="Join community!" />
+</a>
+<a href="https://twitter.com/intent/follow?screen_name=walt_id">
+<img src="https://img.shields.io/twitter/follow/walt_id.svg?label=Follow%20@walt_id" alt="Follow @walt_id" />
+</a>
 
 ## Features
 
-1. **Key Generation**: The application allows you to generate keys using different algorithms such as RSA and Secp256r1.
+1. **Key Generation**: Generate keys using different algorithms (RSA, Secp256r1).
 
-2. **Signing Text**: You can sign any text using the generated keys. The application supports both raw and JWS signing options.
+2. **Text Signing**: Sign text with RAW or JWS signing options. 
 
-3. **DID Creation**: The application can generate DIDs using the generated keys. It supports both 'key' and 'jwk' methods for DID creation.
+3. **DID Creation**: Create DIDs (did:key, did:jwk) based on generated keys. 
 
-4. **Verification**: The application can verify the signed text using the generated keys and DIDs.
+4. **Verification**: Verify signed text using generated keys and DIDs.
 
 ## Screenshots
 
@@ -26,8 +34,8 @@ This project showcases the capabilities of the WALT ID library, demonstrating ho
 
 ## Join the community
 
-* Connect and get the latest updates: <a href="https://discord.gg/AW8AgqJthZ">Discord</a> | <a href="https://walt.id/newsletter">Newsletter</a> | <a href="https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA">YouTube</a> | <a href="https://mobile.twitter.com/walt_id" target="_blank">Twitter</a>
-* Get help, request features and report bugs: <a href="https://github.com/walt-id/.github/discussions" target="_blank">GitHub Discussions</a>
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
 
 ## License
 

waltid-applications/waltid-web-portal/README.md

@@ -48,8 +48,8 @@ docker run -p 7102:7102 -i -t waltid/portal
 
 ## Join the community
 
-* Connect and get the latest updates: <a href="https://discord.gg/AW8AgqJthZ">Discord</a> | <a href="https://walt.id/newsletter">Newsletter</a> | <a href="https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA">YouTube</a> | <a href="https://mobile.twitter.com/walt_id" target="_blank">Twitter</a>
-* Get help, request features and report bugs: <a href="https://github.com/walt-id/.github/discussions" target="_blank">GitHub Discussions</a>
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
 
 ## License
 

waltid-applications/waltid-web-wallet/README.md

@@ -66,8 +66,8 @@ Features are provided by our libraries SSI-Kit and NFT-Kit to enable SSI and NFT
 
 ## Join the community
 
-* Connect and get the latest updates: <a href="https://discord.gg/AW8AgqJthZ">Discord</a> | <a href="https://walt.id/newsletter">Newsletter</a> | <a href="https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA">YouTube</a> | <a href="https://mobile.twitter.com/walt_id" target="_blank">Twitter</a>
-* Get help, request features and report bugs: <a href="https://github.com/walt-id/.github/discussions" target="_blank">GitHub Discussions</a>
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
 
 ## License
 

waltid-libraries/credentials/waltid-mdoc-credentials/README.md

@@ -438,6 +438,12 @@ Namespace: org.iso.18013.5.1
     )
 ```
 
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
 ## License
 
-Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-mdoc/blob/master/LICENSE)
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/credentials/waltid-verifiable-credentials/README.md

@@ -191,3 +191,13 @@ val validationResult = Verifier.verifyPresentation(
         )
     )
 ```
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/crypto/waltid-crypto-android/README.md

@@ -1,4 +1,15 @@
-# Android optional extension for waltid-crypto
+<div align="center">
+ <h1>Optional Android extension for waltid-crypto</h1>
+ <span>by </span><a href="https://walt.id">walt.id</a>
+  <p>Adds support for `AndroidKey`, an Android Keystore backed `Key`.</b><p>
+
+<a href="https://walt.id/community">
+<img src="https://img.shields.io/badge/Join-The Community-blue.svg?style=flat" alt="Join community!" />
+</a>
+<a href="https://twitter.com/intent/follow?screen_name=walt_id">
+<img src="https://img.shields.io/twitter/follow/walt_id.svg?label=Follow%20@walt_id" alt="Follow @walt_id" />
+</a>
+</div>
 
 Platforms: Android-only
 
@@ -7,3 +18,13 @@ Adds support for `AndroidKey`, an Android Keystore backed `Key`.
 ## Build instructions
 Set your `sdk.dir` in `local.properties` and then enable the Android build
 with `enableAndroidBuild=true` in `gradle.properties`.
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/crypto/waltid-crypto-aws/README.md

@@ -1,6 +1,15 @@
-# AWS SDK Extension for walt.id Crypto
-
-A Kotlin-based extension that enhances walt.id crypto with native AWS key management capabilities.
+<div align="center">
+ <h1>AWS SDK Extension for walt.id Crypto</h1>
+ <span>by </span><a href="https://walt.id">walt.id</a>
+  <p>A Kotlin-based extension that enhances walt.id crypto with native AWS key management capabilities.</b><p>
+
+<a href="https://walt.id/community">
+<img src="https://img.shields.io/badge/Join-The Community-blue.svg?style=flat" alt="Join community!" />
+</a>
+<a href="https://twitter.com/intent/follow?screen_name=walt_id">
+<img src="https://img.shields.io/twitter/follow/walt_id.svg?label=Follow%20@walt_id" alt="Follow @walt_id" />
+</a>
+</div>
 
 ## Overview
 
@@ -31,3 +40,13 @@ While the base `AWSKeyRestAPI` offers cross-platform compatibility through REST
 - Enhanced error handling
 - Native integration with AWS services
 
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)
+

waltid-libraries/crypto/waltid-crypto-ios/README.md

@@ -53,3 +53,13 @@ val key = IosKey.create("kid", KeyType.secp256r1)
 #### Implementation details
 
 Module references `:waltid-libraries:waltid-target-ios` that is exposing functionality from static library built by `:waltid-libraries:waltid-target-ios:implementation' module. This module acts as an umbrella for iOS related functionaltiy - for now only crypto things. 
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/crypto/waltid-crypto-oci/README.md

@@ -1,8 +1,29 @@
-# OCI optional extension for waltid-crypto
+<div align="center">
+ <h1>OCI optional extension for waltid-crypto</h1>
+ <span>by </span><a href="https://walt.id">walt.id</a>
+  <p>Adds support for `OCIKey`, an OCI SDK backed `Key`.</b><p>
+
+<a href="https://walt.id/community">
+<img src="https://img.shields.io/badge/Join-The Community-blue.svg?style=flat" alt="Join community!" />
+</a>
+<a href="https://twitter.com/intent/follow?screen_name=walt_id">
+<img src="https://img.shields.io/twitter/follow/walt_id.svg?label=Follow%20@walt_id" alt="Follow @walt_id" />
+</a>
+</div>
 
 Platforms: JVM-only
 
 Adds support for `OCIKey`, an OCI SDK backed `Key`.
 
 This is an alternative to the `OCIRestKey` of base waltid-crypto, which works on all platforms and uses the OCI REST API.
 This module uses the Java OCI SDK instead of the REST API.
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/crypto/waltid-crypto/README.md

@@ -737,3 +737,13 @@ data class AWSKeyMetadata(
 
 For usage examples on _create_, _sign_, _verify_, _import_ and _export_ functions see
 [Working with JWKKey](#working-with-jwkKey).
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/protocols/waltid-openid4vc/README.md

@@ -414,10 +414,6 @@ For the full demo verifier implementation, refer to `/src/jvmTest/kotlin/id/walt
 
 #### Business logic
 
-## License
-
-Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-xyzkit/blob/master/LICENSE)
-
 # Example flows:
 
 ## EBSI conformance test: Credential issuance:
@@ -448,3 +444,13 @@ Issuer -->> Wallet: Credential (and updated c_nonce)
 end
 
 ```
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)

waltid-libraries/sdjwt/waltid-sdjwt/README.md

@@ -354,10 +354,10 @@ console.log("SDMap reconstructed", presentedJwt2.sdMap)
 
 ## Join the community
 
-* Connect and get the latest
-  updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
-* Get help, request features and report bugs: [GitHub Discussions](https://github.com/walt-id/.github/discussions)
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
 
 ## License
 
-Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-nftkit/blob/main/LICENSE)
+Licensed under the Apache License, Version 2.0

waltid-libraries/waltid-did/README.md

@@ -335,3 +335,14 @@ implementation (jwk_jcs-pub encoding) according https://hub.ebsi.eu/tools/librar
 According Universal Resolver: https://github.com/decentralized-identity/universal-resolver/
 
 According Universal Registrar: https://github.com/decentralized-identity/universal-registrar/
+
+
+## Join the community
+
+* Connect and get the latest updates: [Discord](https://discord.gg/AW8AgqJthZ) | [Newsletter](https://walt.id/newsletter) | [YouTube](https://www.youtube.com/channel/UCXfOzrv3PIvmur_CmwwmdLA) | [Twitter](https://mobile.twitter.com/walt_id)
+* Get help, request features and report bugs: [GitHub Issues ](https://github.com/walt-id/waltid-identity/issues)
+
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://github.com/walt-id/waltid-identity/blob/main/LICENSE)