From 551d227a9034021b8e85d0ffc775c75315cd6fe6 Mon Sep 17 00:00:00 2001 From: Tom Kirkpatrick Date: Wed, 31 Jul 2019 13:14:57 +0100 Subject: [PATCH] docs: add documentation index into main README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 78a81db3fd0..caea8a0331d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ We have an active [slack][slack] channel where you can join the discussion on de - [Security](#security) - [Install](#install) - [Usage](#usage) -- [Advanced Usage](#advanced-usage) +- [Documentation](#documentation) - [Get Help](#get-help) - [Maintainers](#maintainers) - [Contribute](#contribute) @@ -64,9 +64,15 @@ Once executible you can run either **double click** the file or run via the cli: ./file.AppImage ``` -## Advanced Usage +## Documentation -If you would like to install from source, run a full bitcoin node, or connect to a custom lnd instance please see the [advanced usage](docs/ADVANCED.md) page. +If you would like to install from source, run a full bitcoin node, connect to a custom lnd instance or get involved with development please refer to our documentation: + +- [Advanced usage](docs/ADVANCED.md) +- [Configuration](docs/CONFIG.md) +- [Contributing](docs/CONTRIBUTING.md) +- [Debugging](docs/DEBUGGING.md) +- [Troubleshooting](docs/TROUBLESHOOTING.md) ## Get Help