From 580e839d9ecdea67ae0f51ad7d5955af42b3b3c0 Mon Sep 17 00:00:00 2001
From: Roger Ferraz <rogerio.ferraz@encora.com>
Date: Tue, 11 Jul 2023 12:39:19 -0300
Subject: [PATCH] starlingx/stx-puppet README improvement

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

Test Plan: N/A

Story: 2010814
Task: 48355

Change-Id: If7d4825337a8057d3be540d96885c7956b857730
Signed-off-by: Roger Ferraz <rogerio.ferraz@encora.com>
---
 README.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..442d944d4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,15 @@
+==========
+stx-puppet
+==========
+The starlingx/stx-puppet repository handles the Puppet service [1]_.
+
+The Puppet service runs during bootstrap, and at every reboot, to provide a
+consistent configuration across the StarlingX system nodes.
+
+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://www.puppet.com
+.. [2] https://opendev.org/starlingx/manifest.git