Comparing version 0.1.2 to 0.1.3
{ | ||
"name": "queez", | ||
"version": "0.1.2", | ||
"version": "0.1.3", | ||
"description": "A simple Javascript library to create quizz", | ||
"main": "index.js", | ||
"main": "dist/index.js", | ||
"repository": { | ||
@@ -7,0 +7,0 @@ "type": "git", |
@@ -1,2 +0,2 @@ | ||
#Queez | ||
# Queez | ||
@@ -7,3 +7,3 @@ A simple Javascript library to create quizz. | ||
##Navigation : | ||
## Navigation : | ||
@@ -16,3 +16,3 @@ * [How to use](#how-to-use-) | ||
##How to use : | ||
## How to use : | ||
@@ -49,5 +49,5 @@ Install `queez` via npm : | ||
##Documentation : | ||
## Documentation : | ||
###Queez : | ||
### Queez : | ||
@@ -92,3 +92,3 @@ <u>Properties :</u> | ||
####`getQuestion(questionId)` => [Question](#question-) : | ||
#### `getQuestion(questionId)` => [Question](#question-) : | ||
Retrieve a question from its id. <br/> | ||
@@ -100,3 +100,3 @@ | ||
####`getQuestionsBy(attribut, value)` => Array of [Question](#question-) : | ||
#### `getQuestionsBy(attribut, value)` => Array of [Question](#question-) : | ||
Retrieve an array of questions from the value of a given attribute | ||
@@ -109,3 +109,3 @@ | ||
####`getQuestionByAnswer` => [Question](#question-) : | ||
#### `getQuestionByAnswer` => [Question](#question-) : | ||
Retrieve a question from an answer id. | ||
@@ -117,3 +117,3 @@ | ||
####`getResult` => [Result](#result-) : | ||
#### `getResult` => [Result](#result-) : | ||
Retrieve a result from its id. | ||
@@ -125,3 +125,3 @@ | ||
####`getResultsBy` => Array of [Result](#result-) : | ||
#### `getResultsBy` => Array of [Result](#result-) : | ||
Retrieve an array of result from the value of a given attribute. | ||
@@ -134,3 +134,3 @@ | ||
####`getCategory` => [Category](#category-) : | ||
#### `getCategory` => [Category](#category-) : | ||
Retrieve a category from its id. | ||
@@ -142,3 +142,3 @@ | ||
####`getCategoriesBy` => Array of [Category](#category-) : | ||
#### `getCategoriesBy` => Array of [Category](#category-) : | ||
Retrieve an array of category from the value of a given attribute. | ||
@@ -151,3 +151,3 @@ | ||
####`isComplete` => Boolean : | ||
#### `isComplete` => Boolean : | ||
Check if all questions has been answered. | ||
@@ -157,3 +157,3 @@ | ||
####`getResponse` => Array of [Result](#result-) | Array of [Question](#question-) (props less): | ||
#### `getResponse` => Array of [Result](#result-) | Array of [Question](#question-) (props less): | ||
Get finals quizz's results. <br/> | ||
@@ -164,3 +164,3 @@ If there is elements in `config.results`, `getResponse` return an `result` array, else return quizz's `question` as 'props less' (just contain properties : `id`, `content`, `custom` and `answer` (props less)). | ||
###Question : | ||
### Question : | ||
@@ -200,3 +200,3 @@ Questions are the main quizz element.<br/> | ||
#####`getAnswer(answerId)` => [Answer](#answer-) : | ||
##### `getAnswer(answerId)` => [Answer](#answer-) : | ||
Retrieve a answer from its id. | ||
@@ -208,3 +208,3 @@ | ||
####`getAnswersBy(attribut, value)` => Array : | ||
#### `getAnswersBy(attribut, value)` => Array : | ||
Retrieve an array of answer from the value of a given attribute. | ||
@@ -217,3 +217,3 @@ | ||
####`isAnswered` => Boolean : | ||
#### `isAnswered` => Boolean : | ||
Return `true` if the question is answered. | ||
@@ -223,3 +223,3 @@ | ||
####`respond` : | ||
#### `respond` : | ||
Respond to the question. | ||
@@ -231,3 +231,3 @@ | ||
####`unRespond` : | ||
#### `unRespond` : | ||
Un-resopnd to the question | ||
@@ -239,7 +239,7 @@ | ||
####`toPropsLess` : | ||
#### `toPropsLess` : | ||
Return the `question` with just `id`, `content`, `custom` and `answers` properties (props less). | ||
###Answer : | ||
### Answer : | ||
@@ -271,6 +271,6 @@ `Answer` are several proposals for a question. <br/> | ||
####`toPropsLess` : | ||
#### `toPropsLess` : | ||
Return `answer` with `id`, `content` and `custom` properties. | ||
###Category : | ||
### Category : | ||
@@ -294,3 +294,3 @@ `category` objects are the elements that make the connection between the questions and possible quiz's result. These may be characterized as the type of question. <br/> | ||
###Result : | ||
### Result : | ||
@@ -372,3 +372,3 @@ `result` objects are the different results possible for the quiz.<br/> | ||
###Callbacks : | ||
### Callbacks : | ||
@@ -404,5 +404,5 @@ `callback` are functions that are called at the end of a specific action. <br/> | ||
##Examples : | ||
## Examples : | ||
###Example 1 : Preferences survey : | ||
### Example 1 : Preferences survey : | ||
@@ -473,3 +473,3 @@ [Sources here](https://github.com/arncet/queez/blob/master/example/quizz-config-survey.js) | ||
###Example 2 : Quizz Super-héros : | ||
### Example 2 : Quizz Super-héros : | ||
@@ -663,3 +663,3 @@ [Sources here](https://github.com/arncet/queez/blob/master/example/quizz-config-super-hero.js) | ||
###Example 3 : With React : | ||
### Example 3 : With React : | ||
@@ -781,3 +781,3 @@ [Demo here](https://arncet.github.io/queez-react-demo/) | ||
##Development: | ||
## Development: | ||
@@ -790,11 +790,4 @@ ``` | ||
##License : | ||
## License : | ||
MIT | ||
139627
767