change(doc): Fix TOC in `README.md` and simplify the "About" section (#6766)
* Remove old sections from the TOC * Simplify the introductory section about Zebra
This commit is contained in:
parent
64da8e6135
commit
8eda11e992
38
README.md
38
README.md
|
@ -7,10 +7,7 @@
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
- [Contents](#contents)
|
|
||||||
- [About](#about)
|
- [About](#about)
|
||||||
- [Using Zebra](#using-zebra)
|
|
||||||
- [Release Candidates](#release-candidates)
|
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#getting-started)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
- [Building Zebra](#building-zebra)
|
- [Building Zebra](#building-zebra)
|
||||||
|
@ -25,27 +22,16 @@
|
||||||
## About
|
## About
|
||||||
|
|
||||||
[Zebra](https://zebra.zfnd.org/) is the Zcash Foundation's independent,
|
[Zebra](https://zebra.zfnd.org/) is the Zcash Foundation's independent,
|
||||||
consensus-compatible implementation of a Zcash node, currently under
|
consensus-compatible implementation of a Zcash node.
|
||||||
development. It can be used to join the Zcash peer-to-peer network, which helps
|
|
||||||
keeping Zcash working by validating and broadcasting transactions, and maintaining
|
|
||||||
the Zcash blockchain state in a distributed manner.
|
|
||||||
|
|
||||||
[Zcash](https://doc.zebra.zfnd.org/zebrad/index.html#about-zcash)
|
Zebra's network stack is interoperable with `zcashd`, and Zebra implements all
|
||||||
is a cryptocurrency designed to preserve the user's privacy.
|
the features required to reach Zcash network consensus, including the validation
|
||||||
If you just want to send and receive Zcash then you don't need to use Zebra
|
of all the consensus rules for the NU5 network upgrade.
|
||||||
directly. You can download a Zcash wallet application which will handle that
|
[Here](https://doc.zebra.zfnd.org/zebrad/index.html#zebra-advantages) are some
|
||||||
for you.
|
benefits of Zebra.
|
||||||
|
|
||||||
Please [join us on Discord](https://discord.gg/na6QZNd) if you'd
|
Zebra validates blocks and transactions, but needs extra software to generate
|
||||||
like to find out more or get involved!
|
them:
|
||||||
|
|
||||||
### Using Zebra
|
|
||||||
|
|
||||||
You would want to run Zebra if you want to contribute to the
|
|
||||||
Zcash network: the more nodes are run, the more reliable the network will be
|
|
||||||
in terms of speed and resistance to denial of service attacks, for example.
|
|
||||||
|
|
||||||
Zebra validates blocks and transactions, but needs extra software to generate them:
|
|
||||||
|
|
||||||
- To generate transactions, [run Zebra with
|
- To generate transactions, [run Zebra with
|
||||||
`lightwalletd`](https://zebra.zfnd.org/user/lightwalletd.html).
|
`lightwalletd`](https://zebra.zfnd.org/user/lightwalletd.html).
|
||||||
|
@ -54,11 +40,8 @@ Zebra validates blocks and transactions, but needs extra software to generate th
|
||||||
miner with Zebra's mining JSON-RPCs. Mining support is currently incomplete,
|
miner with Zebra's mining JSON-RPCs. Mining support is currently incomplete,
|
||||||
experimental, and off by default.
|
experimental, and off by default.
|
||||||
|
|
||||||
Zebra's network stack is interoperable with `zcashd`, and Zebra implements all
|
Please [join us on Discord](https://discord.gg/na6QZNd) if you'd like to find
|
||||||
the features required to reach Zcash network consensus, including the validation
|
out more or get involved!
|
||||||
of all the consensus rules for the NU5 network upgrade.
|
|
||||||
[Here](https://doc.zebra.zfnd.org/zebrad/index.html#zebra-advantages) are some
|
|
||||||
benefits of Zebra.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
@ -133,6 +116,7 @@ book for more details.
|
||||||
#### Optional Features
|
#### Optional Features
|
||||||
|
|
||||||
You can also build Zebra with additional [Cargo features](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options):
|
You can also build Zebra with additional [Cargo features](https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options):
|
||||||
|
|
||||||
- `sentry` for [Sentry monitoring](https://zebra.zfnd.org/user/requirements.html#sentry-production-monitoring)
|
- `sentry` for [Sentry monitoring](https://zebra.zfnd.org/user/requirements.html#sentry-production-monitoring)
|
||||||
- `journald` for [`journald` logging](https://zebra.zfnd.org/user/tracing.html#journald-logging)
|
- `journald` for [`journald` logging](https://zebra.zfnd.org/user/tracing.html#journald-logging)
|
||||||
- `prometheus` for [Prometheus metrics](https://doc.zebra.zfnd.org/zebrad/#metrics)
|
- `prometheus` for [Prometheus metrics](https://doc.zebra.zfnd.org/zebrad/#metrics)
|
||||||
|
|
Loading…
Reference in New Issue