Fix reorg issues
[electrum-server.git] / README.md
1 Electrum-server for the Electrum client
2 =========================================
3
4   * Author: Thomas Voegtlin (ThomasV on the bitcointalk forum)
5   * Language: Python
6
7 Features
8 --------
9
10   * The server indexes UTXOs by address, in a Patricia tree structure
11     described by Alan Reiner (see the 'ultimate blockchain
12     compression' thread in the Bitcointalk forum)
13
14   * Te server requires novacoind, leveldb and plyvel
15
16   * The server code is open source. Anyone can run a server, removing
17     single points of failure concerns.
18
19   * The server knows which set of Novacoin addresses belong to the same
20     wallet, which might raise concerns about anonymity. However, it
21     should be possible to write clients capable of using several
22     servers.
23
24 Installation
25 ------------
26
27   1. To install and run a server, see README.leveldb. For greater
28      detail on the installation process, see HOWTO.md.
29
30   2. To start the server, use the 'start' script. If you do not have a
31      database, it will propose you o download it from the Electrum
32      foundry.
33
34   3. To stop the server, use the 'stop' script. It will shutdown the
35      database cleanly.
36
37
38
39 License
40 -------
41
42 Electrum-server is made available under the terms of the [GNU Affero General
43 Public License](http://www.gnu.org/licenses/agpl.html), version 3. See the 
44 included `LICENSE` for more details.