diff --git a/README.rst b/README.rst index 38b6ccba95..0a1f1a39fb 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,16 @@ -========== -stx-config -========== +====== +config +====== +The starlingx/config repository handles the StarlingX configuration management +services. -StarlingX Configuration Management +Its key component is the System Inventory Service (Sysinv), which provides the +system command-line interface (CLI) [1]_. + +This repository is not intended to be developed standalone, but rather as part +of the StarlingX Source System, which is defined by the StarlingX manifest [2]_. + +References +========== +.. [1] https://docs.starlingx.io/cli_ref/system.html +.. [2] https://opendev.org/starlingx/manifest.git