Skip to content

Commit

Permalink
README.md: add link to lava-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jroimartin committed Aug 11, 2024
1 parent 64b49d0 commit 9309288
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -30,24 +30,27 @@ 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

**This project is in an early stage, we are not accepting external
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

0 comments on commit 9309288

Please sign in to comment.