From 82f7937ade3ac3729b7e91c6f0c66cfa77ef670a Mon Sep 17 00:00:00 2001
From: Carsten Brandt <mail@cebe.cc>
Date: Mon, 6 Jan 2014 05:00:17 +0100
Subject: [PATCH] readme for apidoc

---
 extensions/yii/apidoc/README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/extensions/yii/apidoc/README.md b/extensions/yii/apidoc/README.md
index 7d20c71..0ae1ec3 100644
--- a/extensions/yii/apidoc/README.md
+++ b/extensions/yii/apidoc/README.md
@@ -25,7 +25,17 @@ to the require section of your composer.json.
 Usage
 -----
 
-TDB
+To generate API documentation, run the `apidoc` command.
+
+```
+vendor/bin/apidoc source/directory ./output
+```
+
+By default the `offline` template will be used. You can choose a different templates with the `--template=name` parameter.
+Currently there is only the `offline` template available.
+
+You may also add the `yii\apidoc\commands\RenderController` to your console application class map and
+run it inside of your applications console app.
 
 Creating your own templates
 ---------------------------