survery-lib 0.1.2 → 0.1.3

package/README.md

@@ -1,24 +1,53 @@
-# SurveryLib
+# SurveyWorkspace
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.1.0.
+Survey Library for angular
 
-## Code scaffolding
+## Versions
 
-Run `ng generate component component-name --project survery-lib` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project survery-lib`.
-> Note: Don't forget to add `--project survery-lib` or else it will be added to the default project in your `angular.json` file. 
+| Angular          | Survey Lib |
+|------------------|:----------:|
+| >=16.0.0 <17.0.0 |   v16.x.x  |
 
-## Build
 
-Run `ng build survery-lib` to build the project. The build artifacts will be stored in the `dist/` directory.
+## Getting started
+### Step 1: Install `survery-lib`:
 
-## Publishing
+#### NPM
+```shell
+npm i survery-lib
+```
 
-After building your library with `ng build survery-lib`, go to the dist folder `cd dist/survery-lib` and run `npm publish`.
+### Step 2: Import the SurveryLibModule and angular NgStackFormsModule module:
+```js
+import { NgStackFormsModule } from '@ng-stack/forms';
+import { SurveryLibModule } from 'survery-lib/src/public-api';
+@NgModule({
+  declarations: [AppComponent],
+  imports: [NgStackFormsModule ,SurveryLibModule.forRoot()],
+  bootstrap: [AppComponent]
+})
+export class AppModule {}
+```
 
-## Running unit tests
+### Step 3: Include a theme: 
+```scss
+@import "~survery-lib/assets/style.css";
+```
 
-Run `ng test survery-lib` to execute the unit tests via [Karma](https://karma-runner.github.io).
+### Step 4: to load survey json:
 
-## Further help
+```ts
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+import { SurveyLibService } from 'survery-lib';
+
+ this._SurveyLibService.setSurveyData(surveyJson);;
+
+```
+
+### Step 5: In template use `lib-survery-lib` component with your options
+
+```html
+
+ <lib-survery-lib #surveryLibrary (surveyResultEmit)="onFinishSurvey($event)"></lib-survery-lib>
+
+ ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "survery-lib",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0"