Enhance README.md with detailed technical overview of the project #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: HarshvMahawar <[email protected]>
|
@THS-on @thomas-fossati can you please review this (as the previous merge was lost, created this new PR, no new additions from previously reviewed readme @thomas-fossati) |
README.md
Outdated
| @@ -1,26 +1,68 @@ | |||
| # python-ear | |||
| # **python-ear** | |||
There was a problem hiding this comment.
H1 does not need additional emphasis.
Suggested change
| # **python-ear** | |
| # python-ear |
README.md
Outdated
|
|
||
| A python implementation of [draft-fv-rats-ear](https://datatracker.ietf.org/doc/draft-fv-rats-ear/). | ||
| A Python library that implements the EAT Attestation Result (EAR) data format, as specified in [draft-fv-rats-ear](https://datatracker.ietf.org/doc/draft-fv-rats-ear/). This library provides implementations for both CBOR-based and JSON-based serialisations. |
There was a problem hiding this comment.
Adoption is in flight.
Also, let’s do new-sentence-new-line (NSNL). It’s a good way to make subsequent diffs exactly the right size — BTW, git diff --word-diff is your friend :-)
Suggested change
| A Python library that implements the EAT Attestation Result (EAR) data format, as specified in [draft-fv-rats-ear](https://datatracker.ietf.org/doc/draft-fv-rats-ear/). This library provides implementations for both CBOR-based and JSON-based serialisations. | |
| A Python library that implements the EAT Attestation Result (EAR) data format, as specified in [draft-ietf-rats-ear](https://datatracker.ietf.org/doc/draft-ietf-rats-ear/). | |
| This library provides implementations for both CBOR-based and JSON-based serialisations. |
README.md
Outdated
|
|
||
| Following are the tools that will be used in the development of this library | ||
| ## **Overview** |
There was a problem hiding this comment.
ditto
Suggested change
| ## **Overview** | |
| ## Overview |
README.md
Outdated
|
|
||
| ## CWT and JWT creation | ||
| The goal of this project is to standardize attestation results by defining a shared information and data model, enabling seamless integration with other components of the RATS architecture. This focuses specifically on harmonizing attestation results to facilitate interoperability between various verifiers and relying parties. |
There was a problem hiding this comment.
NSNL
Suggested change
| The goal of this project is to standardize attestation results by defining a shared information and data model, enabling seamless integration with other components of the RATS architecture. This focuses specifically on harmonizing attestation results to facilitate interoperability between various verifiers and relying parties. | |
| The goal of this project is to standardize attestation results by defining a shared information and data model, enabling seamless integration with other components of the RATS architecture. | |
| This focuses specifically on harmonizing attestation results to facilitate interoperability between various verifiers and relying parties. |
README.md
Outdated
|
|
||
| 1. [flake8](https://pypi.org/project/flake8/) | ||
| 2. [mypy](https://pypi.org/project/mypy/) | ||
| ## **Key Features** |
There was a problem hiding this comment.
ditto (there are a few others to fix too.)
Suggested change
| ## **Key Features** | |
| ## Key Features |
README.md
Outdated
|
|
||
| ## Testing | ||
| 1. **Standards Compliance:** | ||
| Implements draft-fv-rats-ear as per IETF specifications to ensure compatibility with the RATS architecture. |
There was a problem hiding this comment.
Suggested change
| Implements draft-fv-rats-ear as per IETF specifications to ensure compatibility with the RATS architecture. | |
| Implements draft-ietf-rats-ear as per IETF specifications to ensure compatibility with the RATS architecture. |
Signed-off-by: HarshvMahawar <[email protected]>
|
incorporated your suggestions @thomas-fossati |
THS-on
approved these changes
Apr 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.