added read only view component

Author: rajeshwarpatlolla

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright © 2018 Fission Labs
+Copyright (c) 2018 Fission Labs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,23 +1,73 @@
-
 # vue-survey-builder
+This is a survey builder component for vue.js applications.
+
+### How to install
+You can install the component using `npm i -S vue-survey-builder`
+
+### Steps to use
+*Step 1:*
+Install is using the above command from npm registry
+There are two components,
+1. **SurveyBuilder**: You can use this to build the survey.
+2. **QuestionsView**: You can use this to view the list of questions added.
+
+You can import them using
+
+`import { SurveyBuilder } from 'SurveyBuilder';`
+
+`import { QuestionsView } from 'SurveyBuilder';`
 
-This is an open-source project, which makes it easy to build custom surveys using vue.js
+*Step 2:*
+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.
 
-### Getting Started
+### Keys of the JSON
+- **id** : This is a unique field, which will be created dynamically for every qiestion. This field is required for all type of questions.
+- **type** : This represents the type of the question. The supported types are mentioned [here](). This field is required for all type of questions.
+- **multiSelect** : This represents whether the question is multi select question or not. This is is `false` by default and will be `true` only for `MULTI_CHOICE` question.
+- **characterLimited** : It represents the limit for characters, the user can enter. This is used for text type of questions.
+- **hasMinMax** : This represents whether the question has any min and max values or not. This will be used by `NUMBER` type of questions only.
+- **allowDecimals** : This represents whether we need to allow the decimals or not. This will be used by `NUMBER` type only.
+- **sequence** : This represents the sequence of the question. This field will be used by all the question types.
+- **minValue** : This represents the min value. This field will be used by `NUMBER` type of questions only.
+- **maxValue** : This represents the max value. This field will be used by `NUMBER` type of questions only.
+- **labels** : This represents the labels for scale type of question. This field is required for scale type only.
+- **dateFormat** : This represents the date format to be shown. This field is required for `DATE` type of questions.
+- **timeFormat** : This represents the date format to be shown. This field is required for `TIME` type of questions. 
+- **intervals** : This represents the number of intervals used for `SCALE` type of questions.
+- **textLimit** : This represents the number character limit for `TEXT` type of questions.
+- **units** : This represents the units to be shown. This field will be used for `NUMBER` type of questions.
+- **options** : This represents the options of question. This field is used by `SINGLE_CHOICE` and `MULTI_CHOICE` questions.
 
-Install the latest version of this component using `npm install vue-survey-builder -S`
+### Supported Question types
+- BOOLEAN
+- SINGLE_CHOICE
+- MULTI_CHOICE
+- SCALE
+- NUMBER
+- TEXT
+- DATE
+- TIME
 
-If you would like to install a specific version(eg: v0.0.1), you can use `npm install vue-survey-builder@0.0.1 -S`
+### Demo
+You can see the demo [here]()
 
-### Contributing
+### Demo Source Code
+Please look at the sample code [here]()
 
-Read [guidelines for contributing](https://help.github.com/articles/setting-guidelines-for-repository-contributors/).
+### Versions
+#### 0.1.0
+This version is the initial official release of this component. It has all the required functionalities to build the surveys using vue.js
 
+### To-Do List
+- Support for rating question
+- Improve JSON
+- Introduce drag and drop
 
-### Future Goals
+### Contributors
+[Rajeshwar Patlolla](https://github.com/rajeshwarpatlolla)
 
-- Introducing drag and drop
-- Improving the object structure
+### Organisation
+[Fission Labs](http://fissionlabs.com/)
 
-### License
-Read our license [here](https://github.com/FissionHQ/vue-survey-builder/blob/master/LICENSE.md)
+### LICENSE
+Please read it [here]()