Merge pull request #3 from fsb4000/master

[electrum-server.git] / README.md

diff --git a/README.md b/README.md
index b5df481..cc1c59a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,43 +1,40 @@
 Electrum-server for the Electrum client
 =========================================
 
-  * Author: thomasv@bitcointalk
+  * Author: Thomas Voegtlin (ThomasV on the bitcointalk forum)
   * Language: Python
 
 Features
 --------
 
-  * The server uses a bitcoind and bitcoin-abe or a leveldb backend.
-  * The server code is open source. Anyone can run a server, removing single
-    points of failure concerns.
-  * The server knows which set of Bitcoin addresses belong to the same wallet,
-    which might raise concerns about anonymity. However, it should be possible
-    to write clients capable of using several servers.
+  * The server indexes UTXOs by address, in a Patricia tree structure
+    described by Alan Reiner (see the 'ultimate blockchain
+    compression' thread in the Bitcointalk forum)
 
-Installation
-------------
+  * Te server requires novacoind, leveldb and plyvel
 
-  1. To install and run a pruning server (easiest setup) see README.leveldb
-  2. Install [bitcoin-abe](https://github.com/jtobey/bitcoin-abe).
-  3. Install [jsonrpclib](https://github.com/joshmarshall/jsonrpclib).
-  4. Launch the server: `nohup python -u server.py > /var/log/electrum.log &`
-     or use the included `start` script.
+  * The server code is open source. Anyone can run a server, removing
+    single points of failure concerns.
 
-See the included `HOWTO.md` for greater detail on the installation process.
+  * The server knows which set of Novacoin addresses belong to the same
+    wallet, which might raise concerns about anonymity. However, it
+    should be possible to write clients capable of using several
+    servers.
 
-### Important Note
+Installation
+------------
 
-Do not run bitcoin-abe and electrum-server simultaneously, because they will
-both try to update the database. 
+  1. To install and run a server, see README.leveldb. For greater
+     detail on the installation process, see HOWTO.md.
 
-If you want bitcoin-abe to be available on your website, run it with 
-the `--no-update` option.
+  2. To start the server, use the 'start' script. If you do not have a
+     database, it will propose you o download it from the Electrum
+     foundry.
 
-### Upgrading Abe
+  3. To stop the server, use the 'stop' script. It will shutdown the
+     database cleanly.
 
-If you upgrade abe, you might need to update the database. In the abe directory, type:
 
-    python -m Abe.abe --config=abe.conf --upgrade
 
 License
 -------