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

Better examples #63

Open
fjarri opened this issue Nov 4, 2024 · 0 comments
Open

Better examples #63

fjarri opened this issue Nov 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@fjarri
Copy link
Member

fjarri commented Nov 4, 2024

Since the API of this crate is complicated, the examples will be the first thing potential users will look at. Currently they are quite messy and poorly documented.

What we need is:

  • Extend the documentation, starting from README explaining which example demonstrates which functionality;
  • Make the example protocols more realistic. Perhaps we can simplify the CGGMP presigning/signing, by cutting out all the Paillier stuff (this will be a good example for chaining protocols, too)? Or perhaps FROST (or a simplified form of it) will work?
@fjarri fjarri added the documentation Improvements or additions to documentation label Nov 4, 2024
@fjarri fjarri added this to the v1.0.0 milestone Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant