Merge branch 'master' into master

[perso/Immae/Projets/Cryptomonnaies/BIP39.git] / readme.md

diff --git a/readme.md b/readme.md
index 75dc6b532b1b93ba6e88181cbdc4b7a1ea618924..269743c96c27fdca4dbb70b3ba088465dd57ca76 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -4,7 +4,7 @@ A tool for converting BIP39 mnemonic phrases to addresses and private keys.
 
 ## Online Version
 
-https://iancoleman.github.io/bip39/
+https://iancoleman.io/bip39/
 
 ## Standalone offline version
 
@@ -28,19 +28,65 @@ import private keys into a wallet or supply someone with a list of addresses.
 
 The BIP32 keys can be used at [bip32.org](https://bip32.org) if desired.
 
+## Donations
+
+Since this project is the efforts of many people, most of which don't appear in
+the obvious places like code or issues, donating to the project itself causes
+significant operational difficulties.
+
+As a result, if you would like to support this project financially you are
+encouraged to donate to one of the many groups that makes the internet a place
+amenable to projects such as this one.
+
+[Donation-accepting organizations and projects](https://en.bitcoin.it/wiki/Donation-accepting_organizations_and_projects)
+
+If the list is too difficult to choose from, the EFF is a good choice.
+
+[Electronic Frontier Foundation](https://supporters.eff.org/donate)
+
+or for a direct bitcoin address, consider donating to the
+[Free Software Foundation](https://www.fsf.org/about/ways-to-donate/)
+at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN
+
+![alt text](https://static.fsf.org/nosvn/images/bitcoin_qrcodes/fsf.png "FSF Bitcoin Address")
+
 ## Making changes
 
 Please do not make modifications to `bip39-standalone.html`, since they will
 be overwritten by `compile.py`.
 
-Make changes in `src/*` and apply them using the command `python compile.py`
+Make changes in `src/*`.
+
+Changes are applied during release using the command `python compile.py`, so
+please do not commit changes to `bip39-standalone.html`
 
 # Tests
 
-Tests depend on [phantomjs](http://phantomjs.org/).
+Tests depend on
+
+* nodejs
+* selenium webdriver - cd /path/to/bip39/tests; npm install
+* selenium driver for firefox ([geckodriver](https://github.com/mozilla/geckodriver/releases)) and / or chrome ([chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads))
+* jasmine - npm install --global jasmine
+
+Before running tests, the site must be served at http://localhost:8000.
+
+```
+$ cd /path/to/bip39/src
+$ python -m http.server
+
+or for python2
+$ python -m SimpleHTTPServer
+```
 
 Run tests from the command-line
 
 ```
-$ phantomjs tests.js
+$ cd /path/to/bip39/tests
+$ jasmine spec/tests.js
 ```
+
+# License
+
+This BIP39 tool is released under the terms of the MIT license. See LICENSE for
+more information or see https://opensource.org/licenses/MIT.