Skip to content

Commit 77110ec

Browse files
updated readme file
1 parent 49cabd7 commit 77110ec

File tree

2 files changed

+11
-18
lines changed

2 files changed

+11
-18
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,24 @@ You can install the component using `npm i -S vue-survey-builder`
66

77
### Demo
88
You can see the demo [here](http://vue-survey-builder.s3-website-us-east-1.amazonaws.com/#/)
9-
10-
### Demo Source Code
11-
Please look at the sample code [here](https://github.com/rajeshwarpatlolla/vue-survey-builder-test)
9+
Please look at the souce code of the demo [here](https://github.com/rajeshwarpatlolla/vue-survey-builder-test)
1210

1311
### Steps to use
14-
*Step 1:*
15-
Once you it install, you can import the `SurveyBuilder` by
12+
**Step 1:**
13+
Once you it install, you can import the `SurveyBuilder` as shown below
1614

1715
`import SurveyBuilder from 'SurveyBuilder';`
1816

19-
*Step 2:*
20-
Then you can use it in your vue component like this
17+
**Step 2:**
18+
Then you can use it in your vue component, as shown below
2119

2220
`<SurveyBuilder :options="sampleQuestion" />`
2321

2422
Here `sampleQuestion` can be the json, which is [here](https://github.com/FissionHQ/vue-survey-builder/blob/master/src/survey-builder.json)
2523

26-
This is used to create a new question.
27-
28-
*Step 3:*
29-
We are using [this JSON](https://github.com/FissionHQ/vue-survey-builder/blob/master/src/survey-builder.json) to build any type of question. Depending on the type of question, only few keys are used in the whole JSON.
24+
This is used to create a new question. We are using this JSON, to build any type of question. Depending on the type of question, only few keys are used in the whole JSON.
3025

26+
**Step 3:**
3127
It emits an event called `add-update-question` with a question object and the type
3228
`this.$root.$emit('add-update-question', question);`
3329

@@ -42,8 +38,8 @@ mounted() {
4238
When you get the object, you can cross check for the `id`, in the list of questions you have. If the `id` exists, then it means there is an update to the question, if the `id` doesn't exist, then you can directly add the question to the list of questions.
4339
You can refer the sample code in the [demo repository](https://github.com/rajeshwarpatlolla/vue-survey-builder-test/blob/master/src/components/TestSurveyBuilder.vue#L30)
4440

45-
*Step 4:*
46-
You can add your own logic in your component to show the list of question in read only and edit mode. There is a component to show the list of questions, which will be available in the [src folder](https://github.com/FissionHQ/vue-survey-builder/blob/master/src/QuestionsView.vue) itself. Please use it in case, if you want to show the questions added.
41+
**Step 4:**
42+
You can add your own logic in your component to show the list of question in read only and edit mode. There is a component to show the list of questions, which will be available in the [demo source code](https://github.com/FissionHQ/vue-survey-builder/blob/master/src/QuestionsView.vue). Please use this component called `QuestionsView` in case, you want to show the list of questions added.
4743

4844
In the next version, this component will be available as part of the vue-survey-builder itself. Refer demo code [here](https://github.com/rajeshwarpatlolla/vue-survey-builder-test/blob/master/src/components/TestSurveyBuilder.vue#L5)
4945

@@ -87,14 +83,11 @@ You can use it like
8783
#### 0.1.0
8884
This version is the initial official release of this component. It has all the required functionalities to build the surveys using vue.js
8985

90-
### To-Do List
86+
### To Do
9187
- Support for rating question
9288
- Improve JSON
9389
- Introduce drag and drop
9490

95-
### Contributors
96-
[Rajeshwar Patlolla](https://github.com/rajeshwarpatlolla)
97-
9891
### Organisation
9992
[Fission Labs](http://fissionlabs.com/)
10093

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-survey-builder",
3-
"version": "0.0.4",
3+
"version": "0.0.5",
44
"description": "A survey builder component for vue.js applications",
55
"main": "src/SurveyBuilder.vue",
66
"scripts": {

0 commit comments

Comments
 (0)