From 33de25bb7c6c3405421cc322df7e591f49a2c1ac Mon Sep 17 00:00:00 2001
From: librelois <elois@ifee.fr>
Date: Sat, 15 Feb 2020 22:37:10 +0100
Subject: [PATCH] [doc] add install instructions & usage example
---
README.md | 21 ++++++++++++++++++---
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index c0084c3..67368bc 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,26 @@
Mnemonic generator
-## CLi usage
+## Install
- dup-mnemonic [OPTIONS]
+[Download debian package on releases page](https://git.duniter.org/tools/dup-mnemonic-rs/-/releases)
-Options :
+### Compile from sources
+
+ git clone https://git.duniter.org/tools/dup-mnemonic-rs
+ cd dup-mnemonic-rs
+ cargo build --release
+
+## Usage
+
+ $ dup-mnemonic [OPTIONS]
+
+Generate a french mnemotic with 12 words:
+
+ $ dup-mnemonic -l fr -w 12
+ narquois horde estrade banlieue vigueur poumon subvenir entier chercher cultiver trancher froid
+
+All options :
-l, --language <language> Mnemotic language [default: en] [possible values: en, zh_HANS, zh_HANT, fr, it,
ja, ko, es]
--
GitLab