From edaefc1e1b8f4d328181e6c4dca066eb2ba5fa37 Mon Sep 17 00:00:00 2001 From: Luis Schwab Date: Thu, 23 Apr 2026 20:28:01 -0300 Subject: [PATCH] feat(doc): add `brew` installation notice to the README --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6d694f59f..fa6c52ff6 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,22 @@ to reuse the same client components across different applications and deployment Floresta is the Portuguese word for forest. It is a reference to the Utreexo accumulator, which is a forest of Merkle trees. It's pronounced _/floˈɾɛstɐ/_. +## Running + +Currently, Floresta is only available for installation on Linux and MacOS via +the [`brew`](https://formulae.brew.sh/formula/floresta) package manager. + +To install and run it: + +```shell +~$ brew install floresta + +~$ florestad +``` + +Alternatively, you can build it from source. Refer to the build instructions +for [Unix](doc/build-unix.md) or [MacOS](doc/build-macos.md). + ## Architecture Floresta is written in Rust and implements modern Bitcoin validation techniques such as @@ -61,10 +77,6 @@ reusable components that can be integrated into Bitcoin applications. [`libfloresta`](https://github.com/getfloresta/Floresta/tree/master/crates) to provide a full node daemon, including a watch-only wallet and an Electrum server. -If you only want to run a node, you can use -[`florestad`](https://github.com/getfloresta/Floresta/tree/master/bin/florestad) by building it from -source, following the instructions for [Unix](doc/build-unix.md) or [MacOS](doc/build-macos.md). - ## Consensus Implementation One of the most challenging parts of working with Bitcoin is keeping up with the consensus rules.