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

Add Dusk additions to README #134

Merged
merged 1 commit into from
Apr 16, 2024
Merged

Add Dusk additions to README #134

merged 1 commit into from
Apr 16, 2024

Conversation

HDauven
Copy link
Member

@HDauven HDauven commented Apr 10, 2024

Resolves #122

Copy link
Member

@moCello moCello left a comment

Choose a reason for hiding this comment

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

I think it would be nice to have a similar disclaimer as in the bls-lib:

⚠️ THIS CRATE IS A FORK OF https://github.com/zkcrypto/bls12_381: The Dusk team has added a variety of tools required for its own uses on the top of the original library. You SHOULD NOT use this library unless you need a specific tool that we've implemented and is not available in the original.

@HDauven
Copy link
Member Author

HDauven commented Apr 16, 2024

I think it would be nice to have a similar disclaimer as in the bls-lib:

⚠️ THIS CRATE IS A FORK OF https://github.com/zkcrypto/bls12_381: The Dusk team has added a variety of tools required for its own uses on the top of the original library. You SHOULD NOT use this library unless you need a specific tool that we've implemented and is not available in the original.

Added with a slight modification 👍

@HDauven HDauven requested a review from moCello April 16, 2024 14:18
Copy link
Member

@moCello moCello left a comment

Choose a reason for hiding this comment

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

LGTM

@HDauven HDauven merged commit 539bfc6 into master Apr 16, 2024
3 checks passed
@HDauven HDauven deleted the docs/122-update-readme branch April 16, 2024 15:57
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.

Update README section with our additions to the crate
2 participants