Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/readme layout #7

Merged
merged 2 commits into from
Oct 17, 2023
Merged

Fix/readme layout #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd79e02
README: compact table
JesusMcCloud Oct 13, 2023
7dfc284
readme fixes
JesusMcCloud Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ types and functionality related to crypto and PKI applications:
This last bit means that
**you can work with X509 Certificates, public keys, CSRs and arbitrary ASN.1 structures on iOS.**

**Do check our the full API docs [here](https://a-sit-plus.github.io/kmp-crypto/)**!
**Do check out the full API docs [here](https://a-sit-plus.github.io/kmp-crypto/)**!

## Usage

Expand All @@ -37,10 +37,10 @@ the JVM/Android and iOS.

This library consists of three modules, each of which is published on maven central:

| Name | `datatypes` | `datatypes-jws` (WIP) | `datatypes-cose` (WIP) |
|---------------------|------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| _Description_ | Base module containing the public key class (`CryptoPublicKey`), algorithm identifiers, the ASN.1 parser, X.509 certificate. | JWS/JWE/JWT module containing JWS/E/T-specific data structures and extensions to convert from/to types contained in the base module. Includes all required kotlinx-serialization magic to allow for spec-compliant de-/serialization. | COSE module containing all COSE/CWT-specific data structures and extensions to convert from/to types contained in the base module. Includes all required kotlinx-serialization magic to allow for spec-compliant de-/serialization. |
| _Maven Coordinates_ | `at.asitplus.crypto:datatypes` | `at.asitplus.crypto:datatypes-jws` | `at.asitplus.crypto:datatypes-cose` |
| Name | `datatypes` | `datatypes-jws` (WIP) | `datatypes-cose` (WIP) |
|----------------|------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| _Info_ | Base module containing the public key class (`CryptoPublicKey`), algorithm identifiers, the ASN.1 parser, X.509 certificate. | JWS/JWE/JWT module containing JWS/E/T-specific data structures and extensions to convert from/to types contained in the base module. Includes all required kotlinx-serialization magic to allow for spec-compliant de-/serialization. | COSE module containing all COSE/CWT-specific data structures and extensions to convert from/to types contained in the base module. Includes all required kotlinx-serialization magic to allow for spec-compliant de-/serialization. |
| _Maven Coords_ | `at.asitplus.crypto:datatypes` | <!--`at.asitplus.crypto:datatypes-jws`--> (WIP; not yet released) | <!--`at.asitplus.crypto:datatypes-cose`--> (WIP; not yet released) |

### Using it in your Projects

Expand Down