diff --git a/projects/ngx-mat-tui-calendar/README.md b/projects/ngx-mat-tui-calendar/README.md index 50b1743..4fef8aa 100644 --- a/projects/ngx-mat-tui-calendar/README.md +++ b/projects/ngx-mat-tui-calendar/README.md @@ -50,25 +50,34 @@ Install via npm: ```bash npm i --save ngx-mat-tui-calendar ``` +which will add `ngx-mat-tui-calendar`, as well as all of its dependencies to your `package.json` file. + Next import the module into your app's ```app.module.ts```: ```typescript import {NgxMatTuiCalendarModule} from 'ngx-mat-tui-calendar'; ``` Then add `NgxMatTuiCalendarModule` to your list of NgModule imports, in ```app.module.ts``` -Insert the following HTML into one of your app's template files +Insert the following HTML into your app's template file ```angular2html ``` +Set up an [Angular theme](https://material.angular.io/guide/theming). For example add the following line to the top of your `src/styles.scss` file +```typescript +@import '~@angular/material/prebuilt-themes/deeppurple-amber.css'; +``` -## Quickstart Project -*TODO* +### Quickstart Project + +A demonstration of the usage described above usage can be found at repo https://github.com/ron2015schmitt/ngx-mat-tui-calendar-quickstart ## Demo Project -*TODO* + +A more extensive demonstration of usage can be found at repo https://github.com/ron2015schmitt/ngx-mat-tui-calendar-demo + ### Stackblitz -*TODO* +*Coming soon* # Documentation @@ -102,6 +111,18 @@ Selector: `ngx-mat-tui-calendar` # Development +## Getting started + +```bash +git clone https://github.com/ron2015schmitt/ngx-mat-tui-calendar +cd ngx-mat-tui-calendar +npm install +ng build +ng serve +``` +Point your browser to http://localhost:4200/ + + ## library package for ngx-mat-tui-calendar The code that makes up the npm package is located in folder ```projects/ngx-mat-tui-calendar```. @@ -116,7 +137,7 @@ The API is defined in ```projects/ngx-mat-tui-calendar/src/public-api.ts```. ### Build -Run `ng build` to build the project. The build artifacts will be stored in the `dist/ngx-mat-tui-calendar` directory. +Run `ng build` to build the library project. The build artifacts will be stored in the `dist/ngx-mat-tui-calendar` directory. ### README diff --git a/projects/ngx-mat-tui-calendar/package.json b/projects/ngx-mat-tui-calendar/package.json index f7f8963..b99524f 100644 --- a/projects/ngx-mat-tui-calendar/package.json +++ b/projects/ngx-mat-tui-calendar/package.json @@ -1,6 +1,6 @@ { "name": "ngx-mat-tui-calendar", - "version": "12.0.3", + "version": "12.0.5", "author": "ron schmitt", "license": "MIT", "description": "Angular Material Design wrapper, supporting theming, for the Toast UI Calendar, suitable for web-based scheduling, events, appointments, and day planner applications.", diff --git a/projects/ngx-mat-tui-calendar/src/lib/ngx-mat-tui-calendar.component.html b/projects/ngx-mat-tui-calendar/src/lib/ngx-mat-tui-calendar.component.html index 3bd7425..64c86ae 100644 --- a/projects/ngx-mat-tui-calendar/src/lib/ngx-mat-tui-calendar.component.html +++ b/projects/ngx-mat-tui-calendar/src/lib/ngx-mat-tui-calendar.component.html @@ -5,7 +5,7 @@
-
+