Update readme and Licence

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

diff --git a/readme.md b/readme.md
index ba3a165f4305becace86e0b102d5d5c46291ccc1..b9418c933d3ddd595bce1a145a7989f3173e053e 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,10 +1,20 @@
+[TOC]
+
 # BIP39 Tool
 
 A tool for converting BIP39 mnemonic phrases to addresses and private keys.
 
+This tool tries to find the best world between Coinomi's and
+iancoleman's versions of the implementation, plus a few additions.
+
+Note that this version is centered on my use of Coinomis's wallet, which
+has a few differences to exact BIP44 implementation:
+
+- Coinomi's Ethereum networks don't use change in the BIP44 path.
+
 ## Online Version
 
-https://iancoleman.github.io/bip39/
+[https://tools.immae.eu/BIP39](https://tools.immae.eu/BIP39)
 
 ## Standalone offline version
 
@@ -55,16 +65,35 @@ at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN
 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