From 8675745e98c26b5096f5e085922b640aceef9733 Mon Sep 17 00:00:00 2001 From: callebtc <93376500+callebtc@users.noreply.github.com> Date: Thu, 18 Jul 2024 00:38:43 +0200 Subject: [PATCH] Add docker compose instructions (#591) --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd7d0e9d..31ae820f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Cashu is a free and open-source [Ecash protocol](https://github.com/cashubtc/nut ## The Cashu protocol Different Cashu clients and mints use the same protocol to achieve interoperability. See the [documentation page](https://docs.cashu.space/) for more information on other projects. If you are interested in developing on your own Cashu project, please refer to the protocol specs [protocol specs](https://github.com/cashubtc/nuts). -## Easy Install +## Easy Install: Nutshell wallet The easiest way to use Cashu is to install the package it via pip: ```bash @@ -51,6 +51,18 @@ If you have problems running the command above on Ubuntu, run `sudo apt install You can skip the entire next section about Poetry and jump right to [Using Cashu](#using-cashu). +## Easy Install: Nutshell mint + +The easiest way to get a mint running is through Docker. + +You can build the image yourself by running the following command. Make sure to adjust the environment variables in `docker-compose.yaml`. + +```bash +docker compose up mint +``` + +Alternatively, you can use the pre-built Docker images, see [Running a mint](#docker). + ## Manual install: Poetry These steps help you install Python via pyenv and Poetry. If you already have Poetry running on your computer, you can skip this step and jump right to [Install Cashu](#poetry-install-cashu).