1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a2c775c
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+Dependency injection framework for Python
+
+DI_ENABLE - module variable to enable/disable
+            the whole DI mechanism (default: True)
+
+@inject   - decorator for classes, function or methods
+            that prepares the injections and executes
+            then when the decorated function or method
+            is called.
+
+            When used on a class it only prepares the
+            structures and instance methods that use DI
+            must be decorated by @usesclassinject
+
+@usesclassinject - this marks an instance method which
+                   should use DI prepared by @inject
+                   on a class level