-
Notifications
You must be signed in to change notification settings - Fork 0
Enhance README with documentation and repository details #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Davidson-Souza
wants to merge
1
commit into
main
Choose a base branch
from
Davidson-Souza-patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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). | ||||||
|
|
||||||
| 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) | | | ||||||
Davidson-Souza marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| |[`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-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) | | |
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".