Browse Source

Add a brief README mention

Signed-off-by: Vadim Markovtsev <vadim@sourced.tech>
Vadim Markovtsev 5 years ago
parent
commit
e1a05ce3c4
1 changed files with 6 additions and 0 deletions
  1. 6 0
      README.md

+ 6 - 0
README.md

@@ -30,6 +30,7 @@ Table of Contents
   * [Overview](#overview)
   * [Installation](#installation)
      * [Build from source](#build-from-source)
+     * [GitHub Action](#github-action)
   * [Contributions](#contributions)
   * [License](#license)
   * [Usage](#usage)
@@ -100,6 +101,11 @@ make
 pip3 install -e ./python
 ```
 
+### GitHub Action
+
+It is possible to run Hercules as a [GitHub Action](https://help.github.com/en/articles/about-github-actions),
+refer to the [sample workflow](.github/workflows/main.yml).
+
 ## Contributions
 
 ...are welcome! See [CONTRIBUTING](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).