From 799c44c6ca7599cfc35a6966d50c22a3d836309d Mon Sep 17 00:00:00 2001
From: Steven Bal <steven@maykinmedia.nl>
Date: Thu, 20 Jun 2024 14:28:51 +0200
Subject: [PATCH] :memo: Extend README

---
 README.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.rst b/README.rst
index 557cfd9..90d05d2 100644
--- a/README.rst
+++ b/README.rst
@@ -19,6 +19,7 @@ Features
 ========
 
 * Bundling shared dependencies and introducing minimum versions for these dependencies
+* Providing generic base Django settings to avoid duplicate settings across registration components
 
 Installation
 ============
@@ -37,6 +38,24 @@ Install
 2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
 3. Recompile the dependencies
 
+If you want to reuse the generic base settings, you can do the following:
+
+* Add the following imports to the project's ``base.py`` file:
+
+```python
+from open_api_framework.conf.base import *  # noqa
+from open_api_framework.conf.utils import config
+```
+
+* Then you can initialize sentry by adding the following line to ``base.py``:
+
+```python
+init_sentry()
+```
+
+* After that, compare the settings from ``open_api_framework.conf.base`` to the settings defined in the project's
+[``base.py``](open_api_framework/conf/base.py) and remove settings from the latter to make use of the generic settings (if this is desired).
+
 Local development
 =================