docs. prepare for stable

mdmsoft · Oct 21, 2014 · 4b7c28a · 4b7c28a
1 parent 3cd2bc8
commit 4b7c28a
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/FileController.php b/FileController.php
@@ -6,7 +6,16 @@
 use yii\web\NotFoundHttpException;
 
 /**
- * FileController
+ * Use to show or download uploaded file. Add configuration to your application
+ * 
+ * ~~~
+ * 'controllerMap' => [
+ *     'file' => 'mdm\upload\FileController',
+ * ],
+ * ~~~
+ * 
+ * Then you can show your file in url `Url::to(['/file','id'=>$file_id])`,
+ * and download file in url `Url::to(['/file/download','id'=>$file_id])`
  *
  * @author Misbahul D Munir <[email protected]>
  * @since 1.0