From 613b58d83727e1362a51b00937c5f0dddca0a086 Mon Sep 17 00:00:00 2001
From: Lennard Wolf <7870758+MultifokalHirn@users.noreply.github.com>
Date: Tue, 2 Jan 2024 01:35:33 +0100
Subject: [PATCH] docs: updated list of decorators to implement in readme

---
 README.md                       | 52 +++++++++++++++++++++++----------
 src/ornaments/markers/stable.py |  0
 src/ornaments/markers/wobbly.py |  0
 3 files changed, 36 insertions(+), 16 deletions(-)
 create mode 100644 src/ornaments/markers/stable.py
 create mode 100644 src/ornaments/markers/wobbly.py

diff --git a/README.md b/README.md
index b2b7059..84497d7 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ It aims to do so through meaningful `@decorator` functions that help other devel
   - [Scope](#scope)
 - [Usage](#usage)
   - [But what if I want to use the same function in different contexts? 🤔](#but-what-if-i-want-to-use-the-same-function-in-different-contexts-)
+- [Goal Structure](#goal-structure)
 - [Development](#development)
 - [Addendum](#addendum)
 
@@ -112,28 +113,47 @@ only_once_callable_function()
 <!-- <img width="1421" alt="Screenshot 2023-12-21 at 01 48 35" src="https://github.com/MultifokalHirn/ornaments/assets/7870758/8fce40d2-65e4-4c1f-8077-d5eb40641bc5"> -->
 🚀
 
-<!-- ## Structure
+<!-- ## Ideas
+
+``` python
+if [typecheck | boolcheck | truthycheck | positivecheck | ...] and [raise | log | ...] error
+```
+
+. -->
+
+## Goal Structure
 
 ``` txt
 .
-├── helpers/
-│   ├── log_execution_time.py
-│   ├── log_parameters.py
+├── helpers
+│   ├── catch_all_exceptions.py
+│   ├── normalized_exceptions.py
 │   └── retry.py
-│
-├── invariants/
+├── invariants
+│   ├── conditional_execution.py
 │   └── only_called_once.py
-│
-├── limiters/
+├── limiters
+│   ├── call_limit.py
 │   └── execution_time_limit.py
-│
-├── markers/
+├── logging
+│   ├── log_calls.py
+│   ├── log_execution_time.py
+│   ├── log_parameters.py
+│   ├── log_return.py
+│   └── log_value.py
+├── markers
+│   ├── stable.py
+│   ├── wobbly.py
 │   └── deprecated.py
-│
-└──  runtime_checks
-    ├── parameter_validation.py
-    └── return_type_validation.py
-
+├── monitoring
+│   ├── monitored_attribute.py
+│   └── monitored_calls.py
+├── runtime_checks
+│   ├── checked_return_type.py
+│   └── parameter_validation.py
+├── safety
+│   └── fallback_function.py
+└── scopes.py
 ```
 
 ``` txt
@@ -152,7 +172,7 @@ only_once_callable_function()
              ::-+**=++-:=--.*%%%==--.:::.
                   :--:==-:--:--:-:::::
                       . . :  : ...
-``` -->
+```
 
 ## Development
 >
diff --git a/src/ornaments/markers/stable.py b/src/ornaments/markers/stable.py
new file mode 100644
index 0000000..e69de29
diff --git a/src/ornaments/markers/wobbly.py b/src/ornaments/markers/wobbly.py
new file mode 100644
index 0000000..e69de29