From: Alec Thomas <alec@swapoff.org>
Date: Fri, 4 Oct 2013 14:48:13 +0000 (-0400)
Subject: Document dependency helper.
X-Git-Url: https://code.bitgloo.com/?a=commitdiff_plain;h=21ba97c1b7df9909bffa36b573fb3451338cdf10;p=clyne%2Fentityx.git

Document dependency helper.
---

diff --git a/README.md b/README.md
index 23f76e3..f5d8ecb 100644
--- a/README.md
+++ b/README.md
@@ -127,6 +127,18 @@ if (position) {
 }
 ```
 
+#### Component dependencies
+
+In the case where a component has dependencies on other components, a helper class exists that will automatically create these dependencies.
+
+eg. The following will also add `Position` and `Direction` components when a `Physics` component is added to an entity.
+
+```c++
+#include "entityx/deps/Dependency.h"
+
+system_manager->add<entityx::deps::Depdendency<Physics, Position, Direction>>();
+```
+
 #### Implementation notes
 
 - Components must provide a no-argument constructor.