Added a documentation section to the README.md (#4865)

This commit is contained in:
Leonard Chinonso 2022-07-29 15:06:59 +01:00 committed by GitHub
parent a862bd9913
commit d866b11923
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -26,6 +26,7 @@ Erigon is an implementation of Ethereum (aka "Ethereum client"), on the efficien
+ [JSON-RPC daemon](#json-rpc-daemon) + [JSON-RPC daemon](#json-rpc-daemon)
+ [Run all components by docker-compose](#run-all-components-by-docker-compose) + [Run all components by docker-compose](#run-all-components-by-docker-compose)
+ [Grafana dashboard](#grafana-dashboard) + [Grafana dashboard](#grafana-dashboard)
- [Documentation](#documentation)
- [FAQ](#faq) - [FAQ](#faq)
- [Getting in touch](#getting-in-touch) - [Getting in touch](#getting-in-touch)
+ [Erigon Discord Server](#erigon-discord-server) + [Erigon Discord Server](#erigon-discord-server)
@ -382,6 +383,16 @@ Windows support for docker-compose is not ready yet. Please help us with .ps1 po
Disabled by default. To enable see `./build/bin/erigon --help` for flags `--prune` Disabled by default. To enable see `./build/bin/erigon --help` for flags `--prune`
Documentation
==============
The `./docs` directory includes a lot of useful but outdated documentation. For code located
in the `./cmd` directory, their respective documentation can be found in `./cmd/*/README.md`.
A more recent collation of developments and happenings in Erigon can be found in the
[Erigon Blog](https://erigon.substack.com/).
FAQ FAQ
================ ================