Skip to content

Commit 3b2e91e

Browse files
committed
Minor documentation updates
1 parent f232aa0 commit 3b2e91e

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.org

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ to a USB drive for printing (or directly printed without the file being saved to
6464
the key. Then key is (conceptually) split between 1 or more groups (not really; each group's
6565
data alone gives away no information about the key).
6666

67-
For example, you might have First, Second, Fam and Frens groups, and decide that any 2 groups can
67+
For example, you might have First, Second, Fam and Fren groups, and decide that any 2 groups can
6868
be combined to recover the key. Each group has members with varying levels of trust and
6969
persistence, so have different number of Members, and differing numbers Required to recover that
7070
group's data:
@@ -76,7 +76,7 @@ to a USB drive for printing (or directly printed without the file being saved to
7676
| First | 1 | / | 1 | Stored at home |
7777
| Second | 1 | / | 1 | Stored in office safe |
7878
| Fam | 2 | / | 4 | Distributed to family members |
79-
| Frens | 2 | / | 6 | Distributed to friends and associates |
79+
| Fren | 2 | / | 6 | Distributed to friends and associates |
8080
#+LATEX: }
8181

8282
The account owner might store their First and Second group data in their home and office safes.
@@ -90,8 +90,8 @@ to a USB drive for printing (or directly printed without the file being saved to
9090
card from the office safe, and 2 cards from Fam group members, and recover the wallet.
9191

9292
If catastrophe strikes and the owner dies, and the heirs don't have access to either the First
93-
(at home) or Second (at the office), they can collect 2 Fam cards and 2 Frens cards (at the
94-
funeral, for example), completing the Fam and Frens groups' data, and recover the HD Wallet
93+
(at home) or Second (at the office), they can collect 2 Fam cards and 2 Fren cards (at the
94+
funeral, for example), completing the Fam and Fren groups' data, and recover the HD Wallet
9595
account. Since Frens are less likely to persist long term (and are also less likely to know
9696
each-other), we'll require a lower proportion of them to be collected.
9797

@@ -106,19 +106,21 @@ to a USB drive for printing (or directly printed without the file being saved to
106106
$ python3 -m pip install slip39 # Install slip39 in Python3
107107
$ cd /Volumes/USBDRIVE/ # Change current directory to USB
108108
$ python3 -m slip39 Personal # Or just run "slip39 Personal"
109-
2021-12-25 11:10:38 slip39 m/44'/60'/0'/0/0 : 0xb44A2011A99596671d5952CdC22816089f142FB3
109+
2021-12-25 11:10:38 slip39 ETH m/44'/60'/0'/0/0 : 0xb44A2011A99596671d5952CdC22816089f142FB3
110110
2021-12-25 11:10:38 slip39 Wrote SLIP-39-encoded wallet for 'Personal' to:\
111111
Personal-2021-12-22+15.45.36-0xb44A2011A99596671d5952CdC22816089f142FB3.pdf
112112
#+END_EXAMPLE
113113
#+LATEX: }
114114

115115
The resultant PDF will be output into the designated file.
116116

117-
This PDF file can be printed on 3x5 cards, or on regular paper or card stock and the cards can be
118-
cut out (=--card credit= or =--card business= are also available).
117+
This PDF file can be printed on 3x5 index cards, or on regular paper or card stock and the cards
118+
can be cut out (=--card credit= , =business=, and =half= or =full= (page) are also available, as
119+
well as custom ="(<h>,<w>),<margin>"=).
119120

120121
To get the data printed on the terminal as in this example (so you could write it down on cards
121-
instead), add a =-v=.
122+
instead), add a =-v= (to see it logged in a tabular format), or =--text= to have it printed to
123+
stdout in full lines (ie. for pipelining to other programs).
122124

123125
** Recover & Regeneration
124126

@@ -143,7 +145,7 @@ to a USB drive for printing (or directly printed without the file being saved to
143145
#+LATEX: {\scriptsize
144146
#+BEGIN_EXAMPLE
145147
$ python3 -m slip39 --secret 383597fd63547e7c9525575decd413f7 --json -
146-
2021-12-25 11:09:57 slip39 ETH(m/44'/60'/0'/0/0): 0xb44A2011A99596671d5952CdC22816089f142FB3
148+
2021-12-25 11:09:57 slip39 ETH m/44'/60'/0'/0/0 : 0xb44A2011A99596671d5952CdC22816089f142FB3
147149
...
148150
JSON key file password: <enter JSON wallet password>
149151
2021-12-25 11:10:38 slip39 Wrote JSON encrypted wallet for '' to:\

README.pdf

1011 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)