diff --git a/README.org b/README.org index 079311a..58affc4 100644 --- a/README.org +++ b/README.org @@ -1,23 +1,23 @@ #+title: Bitcoin Core Container -* About - -This project builds images of [[https://github.com/bitcoin/bitcoin][Bitcoin Core]] for use as [[https://podman.io/][Podman]] or [[https://www.docker.com/][Docker]] containers. It has support for the following platforms: - -- =amd64= -- =arm64= -- =arm32v7= - #+begin_quote The examples in this document use the ~podman~ command. Just swap with the ~docker~ command if you are using Docker. #+end_quote +* About + +This project aims to simplify the process hosting a Bitcoin node. Use either [[https://podman.io/][Podman]] or [[https://www.docker.com/][Docker]] to deploy the containerized [[https://github.com/bitcoin/bitcoin][Bitcoin Core]] images. The following platforms are supported: + +- =amd64= +- =arm64= +- =arm32v7= + +See the [[https://code.fosterhangdaan.com/foster/-/packages/container/bitcoin-core-container][container registry]] for the latest image and [[https://code.fosterhangdaan.com/foster/-/packages/container/bitcoin-core-container/versions][available versions]]. + * Usage #+begin_quote -*IMPORTANT:* It is recommended that you pin the image using the major version tags (ie. =24=, =25=). This way, a manual change is required before updating the service to the next major version. You can use this time to make backups in case something goes wrong. - -The =latest= tag always points to the latest version. So it has a higher chance of introducing a breaking change by accident. Only use =latest= if you like living on the edge. +*IMPORTANT:* Since the =latest= tag has a high chance of introducing a breaking change, it is recommended that you pin the image using the major version tags (ie. =24=, =25=). This way, a manual change is required to update to the next major version. Use this opportunity to make backups in case something goes wrong. #+end_quote To run a container, use either ~podman run~ or define a service in a =compose.yaml= file.