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:
davideandClaude Sonnet 5.5 committed 2026-10-22 16:20:48 +02:00
1 parent 4e1bde28cb
commit 3d05c37feb
10 files changed
+127 -172

No files matched your search

+10 -22
View File
@@ -2,32 +2,20 @@
### 1. Add changelog
Add an entry for the new version at the top of `docs/changelog.rst`.
### 2. Update version number
Both files must have the same version (it is shown to clients by `server.version`, in the banner and in the logs):
- `docs/conf.py`
- `electrumx/__init__.py`
- `src/electrumx/__init__.py`
### 3. Tag
### 3. Check
```
$ git tag -s "$VERSION" -m "$VERSION"
$ git push "$REMOTE_ORIGIN" tag "$VERSION"
```
The CI on `main` (`.github/workflows/ci.yml`) must pass: tests, pycodestyle, docs build, and the Docker image with its
smoke test (`contrib/docker-smoke-test.sh`).
### 4. Build sdist
### 4. Deploy
see [`contrib/sdist/`](contrib/sdist)
```
$ ELECBUILD_COMMIT=HEAD ELECBUILD_NOCACHE=1 ./contrib/sdist/build.sh
```
### 5. Upload to PyPI
```
// $ python3 -m twine upload --repository testpypi dist/$DISTNAME
$ python3 -m twine upload dist/$DISTNAME
```
This will prompt for a username and password. For the username, use `__token__`.
For the password, use API token from https://pypi.org/manage/account/ , including the pypi- prefix.
On the server: `git pull && docker compose up -d --build` (see `DEPLOY.md`).