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.

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

Revised Documentation for Accuracy #11

Merged
merged 3 commits into from
Sep 6, 2024

Conversation

dmccoystephenson
Copy link
Member

Problem

The README is outdated and disorganized.

Solution

The README has been revised for accuracy & clarity.

Dependent PR

This PR includes changes introduced in #10 and should be merged after.

@dmccoystephenson dmccoystephenson changed the title Reviewed & revised README Revised Documentation for Accuracy & Clarity Jul 26, 2024
@dmccoystephenson dmccoystephenson changed the title Revised Documentation for Accuracy & Clarity Revised Documentation for Accuracy Jul 26, 2024
@dmccoystephenson dmccoystephenson marked this pull request as ready for review August 2, 2024 22:04
Copy link

@drewjj drewjj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!


Cryptographic signing is carried out against a remote instance, which requires mutual TLS authentication to secure the communications. This requires using private and public keys to secure the communications between this instance and the remote signing instance.
Copy link

@drewjj drewjj Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to make the repo sound real fancy, you can call it TLS using asymmetric cryptography to secure instance communication. Nothing wrong with explaining how it works, though.

Copy link

@payneBrandon payneBrandon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

README.md Outdated Show resolved Hide resolved
Copy link

@Michael7371 Michael7371 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@dmccoystephenson dmccoystephenson merged commit f3e6afa into dev Sep 6, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants