From fc36b27ce0a583c6ad0061ce0cff185fc1321384 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Mon, 27 Sep 2021 13:16:13 +0200 Subject: [PATCH] docs: describe intended ways to use Renovate (#11197) --- docs/development/design-decisions.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/development/design-decisions.md b/docs/development/design-decisions.md index 08e766daaa9244..2df2c70c714057 100644 --- a/docs/development/design-decisions.md +++ b/docs/development/design-decisions.md @@ -2,6 +2,14 @@ This file documents the design choices as well as configuration options. +## Intended use by end-users + +The Renovate repository/package is intended to be used as a CLI-based application. +It should not be used downstream as a library, because it lacks a stable API. + +End users should only depend on the CLI or on the official hosted app. +The Renovate npm package should only be used as a CLI tool. + ## Stateless A key feature of Renovate is that it does not require any state storage (e.g. on disk or in a database).