=========
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.

  :Licence: MIT
  :Language: Python (>= 3.6)
  :Author: Neil Booth


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


.. toctree::

   features
   changelog
   HOWTO
   ENVIRONMENT
   PROTOCOL
   PEER_DISCOVERY
   RPC-INTERFACE
   ARCHITECTURE


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

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

=========
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.

  :Licence: MIT
  :Language: Python (>= 3.6)
  :Author: Neil Booth

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

See the respository on `github <https://github.com/kyuupichan/electrumx/>`_.

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


.. toctree::

   features
   changelog
   HOWTO
   ENVIRONMENT
   PROTOCOL
   PEER_DISCOVERY
   RPC-INTERFACE
   ARCHITECTURE


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

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

Add a link to the github repo.
Add a link to the github repo.
