From 2ec856eb1d476f35ebc9d8b6dcd7c05bd3503fe6 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Fri, 1 Nov 2019 16:44:51 -0400 Subject: [PATCH] docs: add requirements section to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 651e7cc2..a82ac5f8 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,14 @@ After running the tests, the command `semantic-release` will execute the followi | Publish | Publish the release. | | Notify | Notify of new releases or errors. | +## Requirements + +In order to use **semantic-release** you need: +- To host your code in a [Git repository](https://git-scm.com) +- Use a Continuous Integration service that allows you to [securely set up credentials](docs/usage/ci-configuration.md#authentication) +- Git CLI version [2.7.1 or higher](docs/support/FAQ.md#why-does-semantic-release-require-git-version--271) installed in your Continuous Integration environment +- [Node.js](https://nodejs.org) version [8.16.0 or higher](docs/support/FAQ.md#why-does-semantic-release-require-node-version--816) installed in your Continuous Integration environment + ## Documentation - Usage