From ca34e5dbfd4ba795c74f3dea7d364039545d9621 Mon Sep 17 00:00:00 2001 From: Davidson Souza Date: Wed, 7 Jan 2026 13:39:37 -0300 Subject: [PATCH] Enhance README with documentation and repository details Updated README to include detailed documentation links and improved descriptions of repositories. --- profile/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 profile/README.md diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..11f99ba --- /dev/null +++ b/profile/README.md @@ -0,0 +1,23 @@ +## Hi there 👋 + +Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. You can find all our links on our [website](https://getfloresta.org). + +Detailed documentation for `libfloresta` is available [here](https://docs.getfloresta.sh/floresta/). Additionally, the [`floresta-docs`](https://getfloresta.github.io/floresta-docs/) mdBook provides an in-depth look at the libraries' architecture and internals. Further information can be found in the doc folder. + +### Community + +If you want to discuss this project, you can join our Discord server [here](https://discord.gg/5Wj8fjjS93). + +### About this Org + +This organization holds all the crates related to Floresta, including our +libraries, binaries and integration tools. Here's a list of repositories, with some description about it. + +| Repository | Description | Lead Maintainer | Secondary Maintainer | +|------------|-------------|-----------------|----------------------| +|[`floresta`](https://github.com/getfloresta/floresta) | Floresta's monorepo. Where you can find all the libraries that makes up Floresta, as well as the binaries | [Davidson Souza](https://github.com/Davidson-Souza) | | +|[`floresta-ffi`](https://github.com/getfloresta/floresta-ffi) | Foreign Function Call assets for Floresta, built with UniFFI | [Davidson Souza](https://github.com/Davidson-Souza) | | +|[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | +|[`floresta-makepkg`](https://github.com/getfloresta/floresta-makepkg) | A `makepkg` script for building Floresta on `pacman-based` distros | [Davidson Souza](https://github.com/Davidson-Souza) | | +|[`floresta-qa-assets`](https://github.com/getfloresta/floresta-qa-assets) | Development and QA assets used for Floresta's development | [Davidson Souza](https://github.com/Davidson-Souza) | | +|[`rpc-utreexo-bridge`](https://github.com/getfloresta/rpc-utreexo-bridge) | A simple and fast Utreexo bridge node. | [Davidson Souza](https://github.com/Davidson-Souza) | |