docs: add logo to readme and update readme

Package.swift

@@ -23,20 +23,20 @@ let package = Package(
                 "JSONWebToken"
             ]
         ),
-        // A library just to build full documentation
         .library(
-            name: "JoseDocs",
-            targets: ["JoseDocs"]
-        ),
+            name: "jose-swift-docs",
+            targets: [
+                "jose-swift",
+            ]
+        )
     ],
     dependencies: [
         // For `X448` support
         .package(url: "https://github.com/krzyzanowskim/OpenSSL.git", .upToNextMinor(from: "3.1.4000")),
         // For `secp256k1` support
         .package(url: "https://github.com/GigaBitcoin/secp256k1.swift.git", .upToNextMinor(from: "0.15.0")),
         // For `AES_CBC_HMAC_SHA2`, `PBES2` and RSA DER encoding support
-        .package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", .upToNextMinor(from: "1.8.1")),
-        .package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.3.0")
+        .package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", .upToNextMinor(from: "1.8.1"))
         // FOR `A256_CBC_HS512` with `ECDH-1PU-A256KW`
     ],
     targets: [
@@ -106,7 +106,7 @@ let package = Package(
         ),
         // This target exists just to build documentation it should not be used for development
         .target(
-            name: "JoseDocs",
+            name: "jose-swift",
             dependencies: [
                 "JSONWebKey",
                 "JSONWebSignature",

README.md

@@ -1,16 +1,28 @@
+![Screenshot](jose-swift-logo.png)
 # Jose Swift Library
 
 [![Swift](https://img.shields.io/badge/swift-brightgreen.svg)]() [![iOS](https://img.shields.io/badge/ios-brightgreen.svg)]() [![MacOS](https://img.shields.io/badge/macos-brightgreen.svg)]() [![WatchOS](https://img.shields.io/badge/watchos-brightgreen.svg)]() [![TvOS](https://img.shields.io/badge/tvos-brightgreen.svg)]()
 
 This library provides comprehensive support for the Jose suite of standards, including JWA (JSON Web Algorithms), JWK (JSON Web Key), JWE (JSON Web Encryption), JWS (JSON Web Signature), and JWT (JSON Web Token). These standards are integral to modern security protocols on the web, offering methods for secure key management, data encryption, signing, and representation of claims among different parties.
 
-
-## References
-- [JSON Web Signature (JWS) - RFC 7515](https://datatracker.ietf.org/doc/html/rfc7515)
-- [JSON Web Encryption (JWE) - RFC 7516](https://datatracker.ietf.org/doc/html/rfc7516)
-- [JSON Web Key (JWK) - RFC 7517](https://datatracker.ietf.org/doc/html/rfc7517)
-- [JSON Web Algorithms (JWA) - RFC 7518](https://datatracker.ietf.org/doc/html/rfc7518)
-- [JSON Web Token (JWT) - RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519)
+## Table of Contents
+1. [Available Algorithms](#available-algorithms)
+2. [Requirements](#requirements)
+3. [Swift Package Manager (SPM)](#swift-package-manager-spm)
+   - [Step 1: Add the Dependency](#step-1-add-the-dependency)
+   - [Step 2: Add the Target Dependency](#step-2-add-the-target-dependency)
+   - [Step 3: Import and Use in Your Project](#step-3-import-and-use-in-your-project)
+4. [Documentation](#documentation)
+5. [Modules](#modules)
+   - [JWK (JSON Web Key)](#jwk-json-web-key)
+   - [JWS (JSON Web Signature)](#jws-json-web-signature)
+   - [JWE (JSON Web Encryption)](#jwe-json-web-encryption)
+   - [JWT (JSON Web Token)](#jwt-json-web-token)
+   - [JWA (JSON Web Algorithms)](#jwa-json-web-algorithms)
+6. [Contributing](#contributing)
+7. [References](#references)
+8. [Acknowledgments](#acknowledgments)
+9. [License](#license)
 
 ## Available Algorithms
 
@@ -128,13 +140,33 @@ import JSONWebKey
 import JSONWebToken
 ```
 
+## Documentation
+
+You can access [here](https://beatt83.github.io/jose-swift/documentation/jose_swift/) to the documentation.
+
 ## Modules
 
 ### JWK (JSON Web Key)
-JWK is a standard way to represent cryptographic keys in a JSON format. This module provides functionalities for generating, parsing, and managing JWKs, which are essential for encryption, decryption, and signing processes.
+JWK is a standard way to represent cryptographic keys in a JSON format, as defined in [RFC 7517](https://datatracker.ietf.org/doc/html/rfc7517). This module provides functionalities for generating, parsing, and managing JWKs, which are essential for encryption, decryption, and signing processes.
 
 ### JWS (JSON Web Signature)
-JWS is a standard for digitally signing arbitrary content. This module supports creating and verifying digital signatures, ensuring the integrity and authenticity of signed data.
+JWS is a standard for digitally signing arbitrary content, as detailed in [RFC 7515](https://datatracker.ietf.org/doc/html/rfc7515). This module supports creating and verifying digital signatures, ensuring the integrity and authenticity of signed data.
+
+#### Supported Algorithms:
+- RS256 (RSA Signature with SHA-256)
+- RS384 (RSA Signature with SHA-384)
+- RS512 (RSA Signature with SHA-512)
+- HS256 (HMAC with SHA-256)
+- HS384 (HMAC with SHA-384)
+- HS512 (HMAC with SHA-512)
+- ES256 (ECDSA using P-256 and SHA-256)
+- ES384 (ECDSA using P-384 and SHA-384)
+- ES512 (ECDSA using P-521 and SHA-512)
+- ES256K (ECDSA using secp256k1 and SHA-256)
+- PS256 (RSA PSS with SHA-256)
+- PS384 (RSA PSS with SHA-384)
+- PS512 (RSA PSS with SHA-512)
+- EdDSA (EdDSA using Ed25519) - [RFC 8037](https://datatracker.ietf.org/doc/html/rfc8037)
 
 Example:
 
@@ -151,7 +183,41 @@ try JWS(jwsString: jwsString).verify(key: keyJWK)
 ```
 
 ### JWE (JSON Web Encryption)
-JWE represents encrypted content using JSON-based data structures. This module includes comprehensive functionalities for encrypting and decrypting data, managing encryption keys, and handling various encryption algorithms and methods as specified in the standard.
+JWE represents encrypted content using JSON-based data structures, following the guidelines of [RFC 7516](https://datatracker.ietf.org/doc/html/rfc7516). This module includes functionalities for encrypting and decrypting data, managing encryption keys, and handling various encryption algorithms and methods.
+
+#### Supported Algorithms:
+
+1. **Key Management Algorithms**:
+    - RSA1_5 (RSAES-PKCS1-v1_5)
+    - RSA-OAEP (RSAES OAEP using default parameters)
+    - RSA-OAEP-256 (RSAES OAEP using SHA-256 and MGF1 with SHA-256)
+    - A128KW (AES Key Wrap with default 128-bit key)
+    - A192KW (AES Key Wrap with 192-bit key)
+    - A256KW (AES Key Wrap with 256-bit key)
+    - dir (Direct use of a shared symmetric key)
+    - ECDH-ES (Elliptic Curve Diffie-Hellman Ephemeral Static key agreement)
+    - ECDH-ES+A128KW (ECDH-ES using Concat KDF and A128KW wrapping)
+    - ECDH-ES+A192KW (ECDH-ES using Concat KDF and A192KW wrapping)
+    - ECDH-ES+A256KW (ECDH-ES using Concat KDF and A256KW wrapping)
+    - ECDH-1PU (Elliptic Curve Diffie-Hellman One-Pass Unified Model)
+    - ECDH-1PU+A128KW (ECDH-1PU using Concat KDF and A128KW wrapping)
+    - ECDH-1PU+A192KW (ECDH-1PU using Concat KDF and A192KW wrapping)
+    - ECDH-1PU+A256KW (ECDH-1PU using Concat KDF and A256KW wrapping)
+    - A128GCMKW (Key wrapping with AES GCM using 128-bit key)
+    - A192GCMKW (Key wrapping with AES GCM using 192-bit key)
+    - A256GCMKW (Key wrapping with AES GCM using 256-bit key)
+    - PBES2-HS256+A128KW (PBES2 with HMAC SHA-256 and "A128KW" wrapping)
+    - PBES2-HS384+A192KW (PBES2 with HMAC SHA-384 and "A192KW" wrapping)
+    - PBES2-HS512+A256KW (PBES2 with HMAC SHA-512 and "A256KW" wrapping)
+    - Note: ECDH-1PU is specified in [draft-ietf-jose-cfrg-curves-10](https://datatracker.ietf.org/doc/draft-ietf-jose-cfrg-curves/10/)
+
+2. **Content Encryption Algorithms**:
+    - A128CBC-HS256 (AES CBC using 128-bit key with HMAC SHA-256)
+    - A192CBC-HS384 (AES CBC using 192-bit key with HMAC SHA-384)
+    - A256CBC-HS512 (AES CBC using 256-bit key with HMAC SHA-512)
+    - A128GCM (AES GCM using 128-bit key)
+    - A192GCM (AES GCM using 192-bit key)
+    - A256GCM (AES GCM using 256-bit key)
 
 Example:
 
@@ -174,7 +240,29 @@ let decrypted = try jwe.decrypt(recipientKey: recipientJWK)
 ```
 
 ### JWT (JSON Web Token)
-JWT is a compact, URL-safe means of representing claims to be transferred between two parties. This module offers tools for creating, parsing, validating, and manipulating JWTs, with support for various signing and encryption methods.
+JWT is a compact, URL-safe means of representing claims to be transferred between two parties. This module offers tools for creating, parsing, validating, and manipulating JWTs, with support for various signing and encryption methods, as specified in [RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519).
+
+
+#### Features:
+
+1. **Signed JWTs**:
+    - Supports digital signatures to verify the authenticity and integrity of the token.
+    - Utilizes JWS (JSON Web Signature) standards.
+    - Supports all JWS algorithms previously mentioned.
+
+2. **Encrypted JWTs**:
+    - Facilitates encryption of token content for confidentiality.
+    - Uses JWE (JSON Web Encryption) for robust encryption standards.
+    - Supports all JWE algorithms previously mentioned.
+
+3. **Nested JWT (JWS + JWE)**:
+    - Implements Nested JWTs where a JWT is signed and then encrypted, providing both the benefits of JWS and JWE.
+    - Ensures that a token is first authenticated (JWS) and then secured for privacy (JWE).
+
+4. **Claim Validation**:
+    - Offers extensive capabilities to validate JWT claims.
+    - Includes standard claims like issuer (`iss`), subject (`sub`), audience (`aud`), expiration (`exp`), not before (`nbf`), and issued at (`iat`).
+    - Custom claim validation to meet specific security requirements.
 
 Example:
 
@@ -223,11 +311,19 @@ let verifiedPayload = verifiedJWT.payload
 ```
 
 ### JWA (JSON Web Algorithms)
-JWA specifies cryptographic algorithms used in the context of Jose to perform digital signing and content encryption. It includes standards for various types of algorithms like RSA, AES, HMAC, and more.
+JWA specifies cryptographic algorithms used in the context of Jose to perform digital signing and content encryption, as detailed in [RFC 7518](https://datatracker.ietf.org/doc/html/rfc7518). It includes standards for various types of algorithms like RSA, AES, HMAC, and more.
+
 
 ## Contributing
 Contributions to the library are welcome. Please ensure that your contributions adhere to the Jose standards and add value to the existing functionalities.
 
+## References
+- [JSON Web Signature (JWS) - RFC 7515](https://datatracker.ietf.org/doc/html/rfc7515)
+- [JSON Web Encryption (JWE) - RFC 7516](https://datatracker.ietf.org/doc/html/rfc7516)
+- [JSON Web Key (JWK) - RFC 7517](https://datatracker.ietf.org/doc/html/rfc7517)
+- [JSON Web Algorithms (JWA) - RFC 7518](https://datatracker.ietf.org/doc/html/rfc7518)
+- [JSON Web Token (JWT) - RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519)
+
 ## Acknowledgments
 
 Special thanks to the [`swift-jose`](https://github.com/proxyco/swift-jose) repository by [Zsombor Szabo](https://github.com/zssz) for serving as an inspiration for this project. I have adopted parts of the `JWK` implementation and several test vectors from their work, which have been instrumental in shaping aspects of this library. Their contributions to the open-source community are sincerely appreciated.