zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update zebrad docs and README.

This commit is contained in:
Henry de Valence 2020-02-12 12:40:08 -08:00
parent abcc0a6773
commit 3c9b5612f3
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,14 +1,19 @@
# zebra 🦓 # zebra 🦓
Hello! I am Zebra, an ongoing Rust implementation of a Zcash node. Hello! I am Zebra, an ongoing Rust implementation of a Zcash node.
Zebra is a work in progress. It is developed as a collection of `zebra-*` Zebra is a work in progress. It is developed as a collection of `zebra-*`
libraries implementing the different components of a Zcash node (networking, libraries implementing the different components of a Zcash node (networking,
chain structures, consensus rules, etc), and a `zebrad` binary which uses them. chain structures, consensus rules, etc), and a `zebrad` binary which uses them.
Most of our work so far has gone into `zebra-network`, building a new
networking stack for Zcash, and `zebra-chain`, building foundational data
structures.
[Rendered docs from the `main` branch](https://doc.zebra.zfnd.org). [Rendered docs from the `main` branch](https://doc.zebra.zfnd.org).
[Join us on Discord](https://discord.gg/na6QZNd).
## License ## License
Zebra is distributed under the terms of both the MIT license Zebra is distributed under the terms of both the MIT license

14
zebrad/src/lib.rs
View File

@ -1,8 +1,16 @@
//! Zebrad //! Hello! I am Zebra, an ongoing Rust implementation of a Zcash node.
//! //!
//! Application based on the [Abscissa] framework. //! Zebra is a work in progress. It is developed as a collection of `zebra-*`
//! libraries implementing the different components of a Zcash node (networking,
//! chain structures, consensus rules, etc), and a `zebrad` binary which uses them.
//! //!
//! [Abscissa]: https://github.com/iqlusioninc/abscissa //! Most of our work so far has gone into `zebra-network`, building a new
//! networking stack for Zcash, and `zebra-chain`, building foundational data
//! structures.
//!
//! [Rendered docs from the `main` branch](https://doc.zebra.zfnd.org).
//!
//! [Join us on Discord](https://discord.gg/na6QZNd).
//#![deny(warnings, missing_docs, trivial_casts, unused_qualifications)] //#![deny(warnings, missing_docs, trivial_casts, unused_qualifications)]
#![forbid(unsafe_code)] #![forbid(unsafe_code)]