ngx-mat-tui-calendar 12.0.4 → 12.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -50,25 +50,34 @@ Install via npm:
50
50
  ```bash
51
51
  npm i --save ngx-mat-tui-calendar
52
52
  ```
53
+ which will add `ngx-mat-tui-calendar`, as well as all of its dependencies to your `package.json` file.
54
+
53
55
  Next import the module into your app's ```app.module.ts```:
54
56
  ```typescript
55
57
  import {NgxMatTuiCalendarModule} from 'ngx-mat-tui-calendar';
56
58
  ```
57
59
  Then add `NgxMatTuiCalendarModule` to your list of NgModule imports, in ```app.module.ts```
58
60
 
59
- Insert the following HTML into one of your app's template files
61
+ Insert the following HTML into your app's template file
60
62
  ```angular2html
61
63
  <mat-tui-calendar></mat-tui-calendar>
62
64
  ```
65
+ 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
66
+ ```typescript
67
+ @import '~@angular/material/prebuilt-themes/deeppurple-amber.css';
68
+ ```
63
69
 
64
- ## Quickstart Project
65
- *TODO*
70
+ ### Quickstart Project
71
+
72
+ A demonstration of the usage described above usage can be found at repo https://github.com/ron2015schmitt/ngx-mat-tui-calendar-quickstart
66
73
 
67
74
  ## Demo Project
68
- *TODO*
75
+
76
+ A more extensive demonstration of usage can be found at repo https://github.com/ron2015schmitt/ngx-mat-tui-calendar-demo
77
+
69
78
 
70
79
  ### Stackblitz
71
- *TODO*
80
+ *Coming soon*
72
81
 
73
82
  # Documentation
74
83
 
@@ -102,6 +111,18 @@ Selector: `ngx-mat-tui-calendar`
102
111
 
103
112
  # Development
104
113
 
114
+ ## Getting started
115
+
116
+ ```bash
117
+ git clone https://github.com/ron2015schmitt/ngx-mat-tui-calendar
118
+ cd ngx-mat-tui-calendar
119
+ npm install
120
+ ng build
121
+ ng serve
122
+ ```
123
+ Point your browser to http://localhost:4200/
124
+
125
+
105
126
  ## library package for ngx-mat-tui-calendar
106
127
 
107
128
  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```.
116
137
 
117
138
  ### Build
118
139
 
119
- Run `ng build` to build the project. The build artifacts will be stored in the `dist/ngx-mat-tui-calendar` directory.
140
+ Run `ng build` to build the library project. The build artifacts will be stored in the `dist/ngx-mat-tui-calendar` directory.
120
141
 
121
142
  ### README
122
143
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ngx-mat-tui-calendar",
3
- "version": "12.0.4",
3
+ "version": "12.0.5",
4
4
  "author": "ron schmitt",
5
5
  "license": "MIT",
6
6
  "description": "Angular Material Design wrapper, supporting theming, for the Toast UI Calendar, suitable for web-based scheduling, events, appointments, and day planner applications.",