Skip to content
Snippets Groups Projects
Unverified Commit fc36b27c authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs: describe intended ways to use Renovate (#11197)

parent a541ead4
No related branches found
No related tags found
No related merge requests found
...@@ -2,6 +2,14 @@ ...@@ -2,6 +2,14 @@
This file documents the design choices as well as configuration options. 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 ## Stateless
A key feature of Renovate is that it does not require any state storage (e.g. on disk or in a database). A key feature of Renovate is that it does not require any state storage (e.g. on disk or in a database).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment