From ca66e3c63b0cdc19cf9ec58c47c8461411a3628d Mon Sep 17 00:00:00 2001
From: Carlos Zubieta <1976312+ErraticMaker@users.noreply.github.com>
Date: Tue, 30 Jul 2024 11:50:44 -0700
Subject: [PATCH] Note on the name of the configuration file

Making explicit that only files named `.sops.yaml` will be auto-discovered. And alternative names (like `.sops.yml`) need to be used with the `--config` flag.

Signed-off-by: Carlos Zubieta <1976312+ErraticMaker@users.noreply.github.com>
---
 README.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.rst b/README.rst
index 0c8e4bab4..702f53acb 100644
--- a/README.rst
+++ b/README.rst
@@ -669,6 +669,9 @@ of all new files. If your secrets are stored under a specific directory, like a
 ``git`` repository, you can create a ``.sops.yaml`` configuration file at the root
 directory to define which keys are used for which filename.
 
+Note: The file needs to be named ``.sops.yaml``. Other names (i.e. ``.sops.yml``) won't be automatically
+discovered by sops. You'll need to pass the ``--config .sops.yml`` option for it to be picked up.
+
 Let's take an example:
 
 * file named **something.dev.yaml** should use one set of KMS A, PGP and age