Skip to content

Commit 16730e4

Browse files
committed
Update documentation some more.
1 parent 910e2b2 commit 16730e4

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

docs/index.rst

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
py-dependency-injection
22
=======================
33

4-
A simple yet powerful dependency injection library for Python.
4+
A prototypical dependency injection library for Python.
55

6-
Introduction
7-
------------
6+
Purpose
7+
-------
88

9-
Welcome to py-dependency-injection, a robust dependency injection library designed for Python applications. This library offers a straightforward approach to managing dependencies, enabling you to create more modular, testable, and maintainable code. It's well-suited for a variety of projects, from simple scripts to complex applications.
9+
Dependency injection is a powerful design pattern that promotes loose coupling and enhances testability in software applications. `py-dependency-injection` is a prototypical implementation of this pattern, designed to provide the essential features needed for effective dependency management in both small scripts and larger software projects.
1010

11-
py-dependency-injection provides essential features such as dependency scopes, constructor and method injection, factory and instance registration, and tag-based resolution. These tools allow you to decouple your application components effectively, making your codebase more organized and easier to manage.
11+
This library is particularly suited for beginners exploring the concept of dependency injection, as it offers a straightforward and easy-to-understand implementation. It serves as an excellent starting point for learning the pattern and can also be used as a foundational base for frameworks requiring a more specialized interface for dependency injection.
12+
13+
Key Advantages
14+
--------------
15+
16+
- **Suitable for Learning:** Ideal for beginners exploring the concept of dependency injection.
17+
- **Base Implementation for Frameworks:** Can be used as a foundational base for frameworks requiring a more specialized interface for dependency injection.
18+
- **Standalone Solution:** Can be used on its own as a dependency injection solution in any software project.
1219

1320
Features
1421
--------
@@ -21,6 +28,11 @@ Features
2128
- Instance Registration
2229
- Tag-Based Resolution
2330

31+
Documentation
32+
-------------
33+
34+
For a detailed guide on how to use `py-dependency-injection`, please refer to the examples.
35+
2436
.. userguide-docs:
2537
.. toctree::
2638
:maxdepth: 1

0 commit comments

Comments
 (0)