diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec06eb7 --- /dev/null +++ b/README.md @@ -0,0 +1,158 @@ +# %btc-provider full node on Docker + +[Github](https://github.com/wexpertsystems/urbit-bitcoin-node) + +Urbits communicate with the Bitcoin blockchain via providers, who themselves are connected to full nodes running a few pieces of extra software. This stack can be a little complicated to set up on your own -- using this Docker container should simplify setup and scaling. + +We'll go through the full setup process, from installing Docker to connecting your provider. + +To begin with, you will need **at least** 600GB of disk space available. This setup requires the full blockchain, plus additional space for indexing. Once you have a disk available, make note of its path; you might just use your home directory if if you are running this on a spare PC, or it may be somewhere like `/media/