docs: adapt to Palladium, drop Bitcoin/upstream examples and links
index, features, HOWTO (node requirements, sizes and sync time measured on Palladium, real startup log, clone URL), environment, peer discovery and architecture; rpc-interface examples (getinfo, peers, query with real data); release_process rewritten without tags/PyPI; changelog gets a plm-electrumx 1.0.0 entry above the upstream history. Links point to this repository. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
4e1bde28cb
commit
3d05c37feb
10 files changed
+127
-172
No files matched your search
+18
-22
@@ -1,18 +1,17 @@
|
||||
=========
|
||||
ElectrumX
|
||||
=========
|
||||
=============
|
||||
plm-electrumx
|
||||
=============
|
||||
|
||||
.. image:: https://github.com/spesmilo/electrumx/actions/workflows/ci.yml/badge.svg?branch=master
|
||||
:target: https://github.com/spesmilo/electrumx/actions/workflows/ci.yml
|
||||
.. image:: https://github.com/palladium-coin/plm-electrumx/actions/workflows/ci.yml/badge.svg?branch=main
|
||||
:target: https://github.com/palladium-coin/plm-electrumx/actions/workflows/ci.yml
|
||||
|
||||
This project is a fork of `kyuupichan/electrumx <https://github.com/kyuupichan/electrumx>`_.
|
||||
The original author dropped support for Bitcoin, which we intend to keep.
|
||||
plm-electrumx is an Electrum protocol server for Palladium (PLM). It is a fork of
|
||||
`spesmilo/electrumx <https://github.com/spesmilo/electrumx>`_ (which is itself a fork of
|
||||
`kyuupichan/electrumx <https://github.com/kyuupichan/electrumx>`_) that supports Palladium only.
|
||||
|
||||
ElectrumX allows users to run their own Electrum server. It connects to your
|
||||
full node and indexes the blockchain, allowing efficient querying of history of
|
||||
arbitrary addresses. The server can be exposed publicly, and joined to the public network
|
||||
of servers via peer discovery. As of May 2020, a significant chunk of the public
|
||||
Electrum server network runs ElectrumX.
|
||||
It connects to your Palladium full node and indexes the blockchain, allowing efficient
|
||||
querying of history of arbitrary addresses. The server can be exposed publicly, and joined
|
||||
to the network of servers via peer discovery.
|
||||
|
||||
The current version is |release|.
|
||||
|
||||
@@ -20,12 +19,12 @@ Source Code
|
||||
===========
|
||||
|
||||
The project is hosted on `GitHub
|
||||
<https://github.com/spesmilo/electrumx/>`_. and uses `GitHub Actions
|
||||
<https://github.com/spesmilo/electrumx/actions>`_ for Continuous
|
||||
<https://github.com/palladium-coin/plm-electrumx>`_ and uses `GitHub Actions
|
||||
<https://github.com/palladium-coin/plm-electrumx/actions>`_ for Continuous
|
||||
Integration.
|
||||
|
||||
Please submit an issue on the `bug tracker
|
||||
<https://github.com/spesmilo/electrumx/issues>`_ if you have found a
|
||||
<https://github.com/palladium-coin/plm-electrumx/issues>`_ if you have found a
|
||||
bug or have a suggestion to improve the server.
|
||||
|
||||
Authors and License
|
||||
@@ -35,19 +34,16 @@ Neil Booth wrote the vast majority of the code; see :ref:`Authors`.
|
||||
Python version at least 3.10 is required.
|
||||
|
||||
The code is released under the `MIT Licence
|
||||
<https://github.com/spesmilo/electrumx/LICENCE>`_.
|
||||
<https://github.com/palladium-coin/plm-electrumx/blob/main/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
|
||||
The repository also contains a :file:`Dockerfile` and a :file:`docker-compose.yml` that run the server next
|
||||
to a Palladium node container; see `README.md <https://github.com/palladium-coin/plm-electrumx#with-docker-next-to-the-palladium-node>`_
|
||||
and `DEPLOY.md <https://github.com/palladium-coin/plm-electrumx/blob/main/DEPLOY.md>`_ (ports, firewall, SSL, RPC credentials).
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
Reference in new issue
Block a user