From 5d501eedc78a1bd2e3f8cdbf5b2b25b6165570a3 Mon Sep 17 00:00:00 2001
From: Roger Ferraz <rogerio.ferraz@encora.com>
Date: Thu, 13 Jul 2023 12:58:50 -0300
Subject: [PATCH] starlingx/fault README improvement

This story shall update the README file of a few most used StarlingX
repos.

Test Plan: N/A

Story: 2010814
Task: 48379

Change-Id: I98483245931c5d764c662f5283c59da0b2d69efe
Signed-off-by: Roger Ferraz <rogerio.ferraz@encora.com>
---
 README.rst | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/README.rst b/README.rst
index ea09912c..ab6abf7e 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,14 @@
-=====
-fault
-=====
+=====================
+Fault Management (FM)
+=====================
+The starlingx/fault repository handles Fault Management (FM) services [1]_, and
+provides the fm command-line interface (CLI) [2]_.
 
-StarlingX Fault Management
+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 [3]_.
+
+References
+==========
+.. [1] https://docs.starlingx.io/api-ref/fault
+.. [2] https://docs.starlingx.io/cli_ref/fm.html
+.. [3] https://opendev.org/starlingx/manifest.git