Skip to content

Commit

Permalink
docs: describe intended ways to use Renovate (#11197)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed Sep 27, 2021
1 parent a541ead commit fc36b27
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/development/design-decisions.md
Expand Up @@ -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).
Expand Down

0 comments on commit fc36b27

Please sign in to comment.