Enhance README with documentation and repository details #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -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). | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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. | ||||||
|
Member
There was a problem hiding this comment. I think you should link the |
||||||
|
|
||||||
| ### 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 | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| libraries, binaries and integration tools. Here's a list of repositories, with some description about it. | ||||||
|
Member
There was a problem hiding this comment. I prefer something like
Suggested change
Member
There was a problem hiding this comment. Or |
||||||
|
|
||||||
| | 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) | | | ||||||
Davidson-Souza marked this conversation as resolved.
Show resolved
Hide resolved
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| |[`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".
Suggested change
|
||||||
| |[`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) | | | ||||||
|
Member
There was a problem hiding this comment. What is QA asset, maybe better to write the full wording |
||||||
| |[`rpc-utreexo-bridge`](https://github.com/getfloresta/rpc-utreexo-bridge) | A simple and fast Utreexo bridge node. | [Davidson Souza](https://github.com/Davidson-Souza) | | | ||||||
|
Member
There was a problem hiding this comment. I would remove the dot since it's a small phrase
Suggested change
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "sovernty" should be "sovereignty".