Skip to content

Commit a3f9e60

Browse files
authored
Update README.md
1 parent 4839025 commit a3f9e60

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,28 @@ importspy -s spymodel.yml -l DEBUG path/to/module.py
132132

133133
## 📘 Documentation
134134

135-
- **Full docs**[importspy.readthedocs.io](https://importspy.readthedocs.io)
136-
- [Quickstart](https://importspy.readthedocs.io/en/latest/intro/quickstart.html)
137-
- [Contract syntax](https://importspy.readthedocs.io/en/latest/contracts/syntax.html)
138-
- [Violation system](https://importspy.readthedocs.io/en/latest/advanced/violations.html)
139-
- [API Reference](https://importspy.readthedocs.io/en/latest/api-reference.html)
135+
Full documentation is available at:
136+
👉 **[https://atellaluca.github.io/ImportSpy/](https://atellaluca.github.io/ImportSpy/)**
137+
138+
Here are some useful entry points:
139+
140+
- 🧠 **[How ImportSpy works](https://atellaluca.github.io/ImportSpy/overview/how-it-works/)**
141+
A high-level overview of the validation lifecycle, contract structure, and runtime behavior.
142+
143+
- ⚙️ **[SpyModel architecture](https://atellaluca.github.io/ImportSpy/advanced/spymodel/)**
144+
Deep dive into the declarative model that describes runtime, environment, and module contracts.
145+
146+
- 🧪 **[Violation system](https://atellaluca.github.io/ImportSpy/advanced/violations/)**
147+
Learn how ImportSpy reports context-aware, structured errors on invalid imports.
148+
149+
- 🚀 **[CLI usage](https://atellaluca.github.io/ImportSpy/usage/cli/)**
150+
Run contract validation in CI/CD pipelines or pre-deploy checks with the CLI interface.
151+
152+
- 🛠 **[Embedded usage](https://atellaluca.github.io/ImportSpy/usage/embedded/)**
153+
Use ImportSpy directly inside a module to protect it from being imported in unsupported contexts.
154+
155+
- 📄 **[Writing import contracts](https://atellaluca.github.io/ImportSpy/guides/writing-contracts/)**
156+
Guide to authoring `.yml` contracts: syntax, best practices, and validation patterns.
140157

141158
---
142159

0 commit comments

Comments
 (0)