From 87b9adea370b59a1494053f832ba26224794cc33 Mon Sep 17 00:00:00 2001 From: JSKitty Date: Sat, 8 Jul 2023 15:45:35 +0100 Subject: [PATCH] Update readme documentation --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85c4ae2..3952daf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # VanityGen Powerful PIVX VanityGen written in Rust. -## Usage +## VanityGen Usage ```bash # Choose a target prefix for your address: defaults to "D" for non-vanity mode --target="D" # example: --target=DLabs @@ -17,3 +17,22 @@ A full example may look like: ``` ./pivx-vanity --case-insensitive --threads=6 --target=DLabs ``` + +## PIVX Promos Usage + +As well as having VanityGen: this binary supports PIVX Promos! + +To create a PIVX Promos code, simply specify the quantity of codes to create, and VanityGen will shift to generating Promo Codes, ignoring VanitGen commands. + +```bash +# Choose the quantity of codes to create: if not specified, VanityGen is used +--promo-count= # example: --promo-count=6 + +# Choose a prefix for your PIVX Promo code: defaults to "PIVX Labs" +--promo-prefix="" # example: --promo-prefix="I love PIVX!" +``` + +A full example may look like: +``` +./pivx-vanity --promo-count=1 --promo-prefix="JSKitty is awesome" +``` \ No newline at end of file