From 1af6165a2b12790ceb0ee9b13b7060a3daf3d6c5 Mon Sep 17 00:00:00 2001 From: librelois <elois@ifee.fr> Date: Wed, 19 Feb 2020 01:57:25 +0100 Subject: [PATCH] [doc] rework description and complete README --- Cargo.toml | 2 +- README.md | 15 ++++++++++++++- src/lib.rs | 5 ++++- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 2e2cf66..afde53b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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"] diff --git a/README.md b/README.md index eb46ea4..5040ca8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [](https://codecov.io/gh/duniter/dup-crypto-rs) [](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`. diff --git a/src/lib.rs b/src/lib.rs index 0dec2f9..7793628 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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, -- GitLab