update documentation
authorThomasV <thomasv1@gmx.de>
Fri, 7 Mar 2014 09:22:59 +0000 (10:22 +0100)
committerThomasV <thomasv1@gmx.de>
Fri, 7 Mar 2014 09:22:59 +0000 (10:22 +0100)
HOWTO.md
README.leveldb
README.md

index c0c0432..af81673 100644 (file)
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -291,20 +291,18 @@ Two more things for you to consider:
 
 The magic moment has come: you can now start your Electrum server:
 
-    $ electrum-server
+    $ start
 
 You should see this on the screen:
 
     starting Electrum server
     cache: yes
 
-If you want to stop Electrum server, open another shell and run:
+If you want to stop Electrum server, use the 'stop' script:
+
+    $ stop
 
-    $ electrum-server stop
 
-You should also take a look at the 'start' and 'stop' scripts in
-`~/src/electrum/server`. You can use them as a starting point to create a
-init script for your system.
 
 ### Step 13. Test the Electrum server
 
index ff08823..4aa5f18 100644 (file)
@@ -68,7 +68,8 @@ _________________________________
 5. enjoy!
 
 Once the server is synchronized, it will listen to ports, and the
-normal way to stop it is to type: ./server.py stop
+normal way to stop it is to use the 'stop' script. This script will
+wait until the database is closed.
 
 Other commands are available: 
 
index d2bd190..e103a5e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +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 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)
+
+  * Te server requires bitcoind, leveldb and plyvel
+
+  * 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.
 
 Installation
 ------------
 
-  1. To install and run a pruning server (easiest setup) see README.leveldb
-  2. Install [jsonrpclib](https://github.com/joshmarshall/jsonrpclib).
-  3. Launch the server: `nohup python -u server.py > /var/log/electrum.log &`
-     or use the included `start` script.
+  1. To install and run a server, see README.leveldb. For greater
+     detail on the installation process, see HOWTO.md.
+
+  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.
+
+  3. To stop the server, use the 'stop' script. It will shutdown the
+     database cleanly.
+
 
-See the included `HOWTO.md` for greater detail on the installation process.
 
 License
 -------