Skip to content
Snippets Groups Projects
Commit 1af6165a authored by Éloïs's avatar Éloïs
Browse files

[doc] rework description and complete README

parent 4dc000c5
No related branches found
No related tags found
No related merge requests found
......@@ -2,7 +2,7 @@
name = "dup-crypto"
version = "0.9.0"
authors = ["elois <c@elo.tf>"]
description = "Manage cryptographic operations for DUPs (DUniter Protocols)."
description = "Manage cryptographic operations for DUniter Protocols and the Duniter eco-system most broadly."
repository = "https://git.duniter.org/libs/dup-crypto-rs"
readme = "README.md"
keywords = ["keys", "cryptography", "duniter", "dunitrust"]
......
......@@ -4,7 +4,9 @@
[![codecov](https://codecov.io/gh/duniter/dup-crypto-rs/branch/dev/graph/badge.svg)](https://codecov.io/gh/duniter/dup-crypto-rs)
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.41.0+-yellow.svg)](https://github.com/rust-lang/rust/blob/master/RELEASES.md)
Cryptographic toolkit for the DUBP(1) and DUNP(2) protocols.
Manage cryptographic operations for DUniter Protocols and the Duniter eco-system most broadly.
`DUP` means DUniter Protocols.
(1): DUniter Blockchain Protocol
(2): DUniter Network Protocol
......@@ -17,3 +19,14 @@ Cryptographic toolkit for the DUBP(1) and DUNP(2) protocols.
* Secure random byte generation
* Scrypt to generate seed from credentials.
* Ed25519 functions to create and use ed25519 keypair.
* [DEWIF](https://git.duniter.org/nodes/common/doc/blob/dewif/rfc/0013_Duniter_Encrypted_Wallet_Import_Format.md) format read/write
## Documentation
Generated documentation : https://docs.rs/dup-crypto
This documentation contains examples of code whose validity is assured (all code in the documentation is compiled on continuous integration).
## Support
If this library serves you well, you can make a donation on my Ğ1 public key `D9D2zaJoWYWveii1JRYLVK3J4Z7ZH3QczoKrnQeiM6mx`.
......@@ -13,7 +13,10 @@
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//! Manage cryptographic operations.
//! Manage cryptographic operations for DUniter Protocols and the Duniter eco-system most broadly.
//!
//! `dup` means DUniter Protocols.
//!
#![deny(
clippy::option_unwrap_used,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment