From 9309288581ae99ccaa8bdb723a89f838a03262dd Mon Sep 17 00:00:00 2001
From: Roi Martin <jroi.martin@gmail.com>
Date: Sun, 11 Aug 2024 01:19:59 +0200
Subject: [PATCH] README.md: add link to lava-docs

---
 README.md | 31 +++++++++++++++++--------------
 1 file changed, 17 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 884ef06..1b5639b 100644
--- a/README.md
+++ b/README.md
@@ -5,20 +5,20 @@ security checks in your local and CI/CD environments.
 
 <p align="center"><img width="128" alt="Lava logo" src="https://github.com/adevinta/lava-resources/releases/download/logo/v0.1.0/lava_512px.png"></p>
 
-Lava is part of the [Vulcan ecosystem][vulcan-docs] and it is built on
-top of the same components that power Vulcan.
+Lava is part of the [Vulcan ecosystem] and it is built on top of the
+same components that power Vulcan.
 Thus, Lava continuously benefits from Vulcan improvements.
-In fact, Lava is compatible with the [vulcan-checks][vulcan-checks]
-catalog shipped with Vulcan.
+In fact, Lava is compatible with the [vulcan-checks] catalog shipped
+with Vulcan.
 
 ## Install
 
-### Binary Distributions
+### Binary distributions
 
 Official binary distributions are available at
 https://github.com/adevinta/lava/releases.
 
-### Install From Source
+### Install from source
 
 Install the Lava command with `go install`.
 
@@ -30,13 +30,17 @@ go install github.com/adevinta/lava/cmd/lava@latest
 
 Lava is also available as an action that can be used from GitHub
 Actions workflows.
-Visit [adevinta/lava-action][lava-action] for usage instructions.
+Visit https://adevinta.github.io/lava-docs/github_actions.html for
+usage instructions.
 
 ## Documentation
 
-Lava is self-documented.
-Please run `lava help` to get more information about the available
-commands and other related topics.
+The user documentation is available at
+https://adevinta.github.io/lava-docs.
+
+Also, the Lava command is self-documented.
+Run `lava help` to get more information about the available commands
+and other related topics.
 
 ## Contributing
 
@@ -44,10 +48,9 @@ commands and other related topics.
 contributions yet.**
 
 To contribute, please read the [contribution
-guidelines][contributing].
+guidelines].
 
 
-[vulcan-docs]: https://adevinta.github.io/vulcan-docs
+[Vulcan ecosystem]: https://adevinta.github.io/vulcan-docs
 [vulcan-checks]: https://github.com/adevinta/vulcan-checks
-[lava-action]: https://github.com/adevinta/lava-action
-[contributing]: /CONTRIBUTING.md
+[contribution guidelines]: /CONTRIBUTING.md