Enhance README with documentation and repository details #1
Conversation
|
Missing website link |
profile/README.md
Outdated
| @@ -0,0 +1,23 @@ | |||
| ## Hi there 👋 | |||
|
|
|||
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovernty. | |||
There was a problem hiding this comment.
Floresta stands for the Bitcoin Open Source Software project offering florestad, a utreexo based bitcoin client, and its modules being offered trough libfloresta.
WYT ?
There was a problem hiding this comment.
Our branding is going more towards flexibility and reusability, so I think the original makes more sense
Updated README to include detailed documentation links and improved descriptions of repositories.
Davidson-Souza
force-pushed
the
Davidson-Souza-patch-1
branch
from
906552b to
ca34e5d
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive README file to the organization's profile directory, introducing Floresta - a collection of tools for developing Bitcoin clients. The README includes community links, documentation references, and a detailed repository table listing all related projects with their maintainers.
Changes:
- Added new profile README with project introduction and documentation links
- Created repository inventory table with descriptions and maintainer information
- Included community Discord server link
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -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). | |||
There was a problem hiding this comment.
Spelling error: "sovernty" should be "sovereignty".
| 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). | |
| Foresta is a collection of tools for developing Bitcoin clients that offers better privacy and sovereignty. You can find all our links on our [website](https://getfloresta.org). |
| |------------|-------------|-----------------|----------------------| | ||
| |[`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) | | |
There was a problem hiding this comment.
Spelling error: "ackages" should be "packages".
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, ackages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | | |
| |[`floresta-flake`](https://github.com/getfloresta/floresta-flake) | Nix support for services, packages and resources for Floresta | [jaoleal](https://github.com/jaoleal) | | |
Updated README to include detailed documentation links and improved descriptions of repositories.