=========
ElectrumX
=========

.. image:: https://travis-ci.org/kyuupichan/electrumx.svg?branch=master
    :target: https://travis-ci.org/kyuupichan/electrumx
.. image:: https://coveralls.io/repos/github/kyuupichan/electrumx/badge.svg
    :target: https://coveralls.io/github/kyuupichan/electrumx

A reimplementation of Electrum-Server for a future with bigger blocks.

The current version is |release|.

Source Code
===========

The project is hosted on `GitHub
<https://github.com/kyuupichan/electrumx/>`_.  and uses `Travis
<https://travis-ci.org/kyuupichan/electrumx>`_ for Continuous
Integration.

Please submit an issue on the `bug tracker
<https://github.com/kyuupichan/electrumx/issues>`_ if you have found a
bug or have a suggestion to improve the server.

Authors and License
===================

Neil Booth wrote the vast majority of the code; see :ref:`Authors`.
Python version at least 3.7 is required.

The code is released under the `MIT Licence
<https://github.com/kyuupichan/electrumx/LICENCE>`_.

Getting Started
===============

See :ref:`HOWTO`.

There is also an `installer`_ available that simplifies the
installation on various Linux-based distributions, and a `Dockerfile`_
available .

.. _installer: https://github.com/bauerj/electrumx-installer
.. _Dockerfile: https://github.com/lukechilds/docker-electrumx

Documentation
=============

.. toctree::

   features
   changelog
   HOWTO
   environment
   protocol
   peer_discovery
   rpc-interface
   architecture
   authors

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`