]> git.immae.eu Git - perso/Immae/Projets/Cryptomonnaies/BIP39.git/blame - readme.md
update readme with Slimcoin-specific text
[perso/Immae/Projets/Cryptomonnaies/BIP39.git] / readme.md
CommitLineData
ebd8d4e8
IC
1# BIP39 Tool
2
3A tool for converting BIP39 mnemonic phrases to addresses and private keys.
4
5## Online Version
6
e8f46253
GH
7Upstream demo: https://iancoleman.github.io/bip39/
8
9Slimcoin: TBD
ebd8d4e8
IC
10
11## Standalone offline version
12
13Download `bip39-standalone.html`
14
15Open the file in a browser by double clicking it.
16
ab78acc6
IC
17This can be compiled from source using the command `python compile.py`
18
ebd8d4e8
IC
19## Usage
20
21Enter your BIP39 phrase into the 'BIP39 Phrase' field, or press
22'Generate Random Phrase'
23
24If required, set the derivation path, although the defaults are quite usable.
25
26See the table for a list of addresses generated from the phrase.
27
28Toggle columns to blank to easily copy/paste a single column of data, eg to
29import private keys into a wallet or supply someone with a list of addresses.
30
31The BIP32 keys can be used at [bip32.org](https://bip32.org) if desired.
ab78acc6 32
1e6a9f41
IC
33## Donations
34
35Since this project is the efforts of many people, most of which don't appear in
36the obvious places like code or issues, donating to the project itself causes
37significant operational difficulties.
38
39As a result, if you would like to support this project financially you are
40encouraged to donate to one of the many groups that makes the internet a place
41amenable to projects such as this one.
42
43[Donation-accepting organizations and projects](https://en.bitcoin.it/wiki/Donation-accepting_organizations_and_projects)
44
45If the list is too difficult to choose from, the EFF is a good choice.
46
47[Electronic Frontier Foundation](https://supporters.eff.org/donate)
48
49or for a direct bitcoin address, consider donating to the
982e4e75 50[Free Software Foundation](https://www.fsf.org/about/ways-to-donate/)
1e6a9f41
IC
51at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN
52
53![alt text](https://static.fsf.org/nosvn/images/bitcoin_qrcodes/fsf.png "FSF Bitcoin Address")
54
ab78acc6
IC
55## Making changes
56
57Please do not make modifications to `bip39-standalone.html`, since they will
58be overwritten by `compile.py`.
59
60Make changes in `src/*` and apply them using the command `python compile.py`
88e2cdaa
IC
61
62# Tests
63
64Tests depend on [phantomjs](http://phantomjs.org/).
65
66Run tests from the command-line
67
68```
69$ phantomjs tests.js
70```
24ebb699
IC
71
72# License
73
74This BIP39 tool is released under the terms of the MIT license. See LICENSE for
75more information or see https://opensource.org/licenses/MIT.