#8 & #9

- Documentation - Following bundle best practices
egulias · Mar 18, 2012 · 4d7482e · 4d7482e
1 parent 2496423
commit 4d7482e
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 2 deletions.
diff --git a/Resources/doc/index.md b/Resources/doc/index.md
@@ -1 +1,15 @@
-**Documentation Index for the EguliasQuizBundle**
+Getting Started With EguliasQuizBundle
+=====================================
+
+## Installation
+
+Here [Setting up the bundle](installation.md)
+
+## Bundle usage
+
+EguliasQuizBundle give's your site the bility to quickly implement questionaries.
+
+Here you'll learn [how to use it](usage.md)
+
+
+
diff --git a/Resources/doc/usage.md b/Resources/doc/usage.md
@@ -3,6 +3,39 @@
 The QuizBundle comes with a set of predefined urls to point to basic controllers so you can start using the bundle
 out of the box.
 
+## Controllers
+
+All the controllers mostly implements one of the two available services (see services section for mor information).
+
+  - QuizManagerController.php
+  - QuestionController.php (in course of beeing refactored)
+  - QuizController.php
+  - AnswerController.php
+
+If you want to personalize any of the controllers you can just pick the services and create your owns.
+
 ## Services
 
-Two services are available with the bundle
+Two services are available with the bundle (a third is planned for managing questions):
+
+- egulias.quiz.manager
+- egulias.take.quiz
+
+1. egulias.quiz.manager
+
+Implements a series of methods to allow the cration and modification of quizes. These are:
+
+* getQuizForm
+* saveQuizForm
+* editQuizForm
+* updateQuizForm
+
+2. egulias.take.quiz
+
+This service allows the user to take a given quiz. It implements two methods for this:
+
+* takeQuiz
+  Returning the quiz form
+
+* responseQuiz
+  Responsible for saving the user answers from the quiz id