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

Update readme #19

Merged
merged 12 commits into from
Oct 18, 2023
Merged

Update readme #19

merged 12 commits into from
Oct 18, 2023

Conversation

RaekwonIII
Copy link
Collaborator

Re-created branch with cherry-picked commits and made a few fixes on the final result.

Please disregard previous pull request.

@lior-blox @y0sher

Added Introduction
Added Overview
Standardized Initiator/Operator naming convention
Refactored Flow description
Moved Security Notes to the bottom
Added Table of Contents
Added entire public keys
Added explanation about operator info file
Added latest changes and parameters
@liorrutenberg liorrutenberg mentioned this pull request Oct 17, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 171 to 173
## Architecture
## Operator Quick start

![flow](./docs/imgs/DKGinit.drawio.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we should move flow and architecture to a different file. its worth to have a note about the arch and design for more advanced users. but its not a must in the readme.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It is at the very end of the file. I do understand it's quite long, but since there's a table of content it's navigable at least.
If we want to move it to a different file, I am not opposed to that either.

Copy link
Contributor

@y0sher y0sher left a comment

Choose a reason for hiding this comment

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

looks awesome, some comments. hope they are clear and helpful.

Copy link
Collaborator Author

@RaekwonIII RaekwonIII left a comment

Choose a reason for hiding this comment

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

Acted on requested changes in new commit

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@liorrutenberg liorrutenberg merged commit aa2d231 into ssvlabs:main Oct 18, 2023
1 check passed
@RaekwonIII RaekwonIII deleted the update-readme branch October 20, 2023 13:59
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.

3 participants