Skip to content

Commit 2816ac3

Browse files
committed
docs(readme): improved image representation
1 parent 30d4ebc commit 2816ac3

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ Runtime-safe. Structure-aware. Declarative.
2929
ImportSpy allows your Python modules to define explicit **import contracts**:
3030
rules about where, how, and by whom they can be safely imported — and blocks any import that doesn’t comply.
3131

32-
.. image:: https://raw.githubusercontent.com/atellaluca/ImportSpy/refs/heads/main/assets/importspy-works.png
33-
:alt: How ImportSpy Works
34-
:width: 830
35-
3632
🔍 Key Benefits
3733
---------------
3834

@@ -57,6 +53,10 @@ ImportSpy offers you **runtime import governance** — clearly defined, enforced
5753
📐 Architecture Highlight
5854
-------------------------
5955

56+
.. image:: https://raw.githubusercontent.com/atellaluca/ImportSpy/refs/heads/main/assets/importspy-spy-model-architecture.png
57+
:alt: ImportSpy, SpyModel Architecture
58+
:width: 830
59+
6060
ImportSpy uses a layered model (`SpyModel`) that mirrors your execution context and module structure:
6161

6262
- `Runtime` → defines architecture and system
@@ -112,6 +112,10 @@ Each element is introspected and validated dynamically, at runtime or via CLI.
112112
113113
**CLI Mode** – validate externally in CI/CD:
114114

115+
.. image:: https://raw.githubusercontent.com/atellaluca/ImportSpy/refs/heads/main/assets/importspy-works.png
116+
:alt: How ImportSpy CLI Mode Works
117+
:width: 830
118+
115119
.. code-block:: bash
116120
117121
importspy -s spymodel.yml -l DEBUG path/to/module.py
120 KB
Loading

0 commit comments

Comments
 (0)