Merge pull request #7 from eksrvb/bufgix/prepare-rework

prepare rework

Author: eksrha

README.md

@@ -2,11 +2,18 @@
 Please read this **before** usage!
 This material calendar is just beginning. As in the angular material components, a beautiful calendar is to be generated by simple integration. Cooperation is welcome.
 
-> Note: tthe following changes from version 3.0.0 onwards will no longer be compatible with this api. All necessary changes are documented. Version 3.0.0 is coming soon ;)
+> Warning: during the migration to github parts of the project were mixed up !!
+All features can be lost after an update from 2.1.2 to> 2.1.2.
+This will be solved in version 3.0.0, which will come as soon as I can.
+From version 3.0.0 onwards there will be a stable API with extensive features and its own documentation
 
 ### Working demo
 [demo github project](https://github.com/eksrvb/material-calendar-demo)
 
+![material-calendar-single-month](https://github.com/eksrvb/material-calendar/docs/material-calendar-single-month.png)
+![material-calendar-three-months](https://github.com/eksrvb/material-calendar/docs/material-calendar-three-months.png)
+![material-calendar-two-months-with-placeholder](https://github.com/eksrvb/material-calendar/docs/material-calendar-two-months-with-placeholder.png)
+
 ## Installing
 `npm i material-calendar`
 
@@ -57,6 +64,7 @@ All options are shown here:
 	(clickDate)="yourMethod($event)">
 </calendar-panels>
 <!--
+	default mode = monthly
 	default placeholderDay = false
 	default year = current year
 	default month = current month
@@ -67,20 +75,17 @@ All options are shown here:
 ``` typescript
 import { CalendarConfig } from  'material-calendar';
 
-placeholder = false  // boolean
-mode = 'monthly'  // 'annual' | 'monthly'
+placeholder = false  // boolean ...can be hardcoded in html
+mode = 'monthly'  // 'annual' | 'monthly' ...can be hardcoded in html
 
 calendarConfig: CalendarConfig = {
 	panelBgColor:  '#00677f', // use only hex or rbg colors
 	autoTextColor:  true,
 	textColor:  '#fff', // use only hex or rbg colors
-	useHolidays:  false,
-	holidayColor:  'rgb(253, 173, 0)', // use only hex or rbg colors
-	holidayTextColor:  'rgb(253, 173, 0)', // use only hex or rbg colors
 	displayYear: true,
     firstDayOfWeekMonday: true,
     todayColor: '#fff',
-    panelWidth: '100%',
+    panelWidth: '100%', // can also be fix values such as 350px
     calendarWeek: true,
     switches: false,
 }
@@ -89,13 +94,10 @@ calendarConfig: CalendarConfig = {
 /**
 * @param  {boolean}  autoTextColor Sets the text color automatically, based on the backgroud colors
 * @param  {boolean}  calendarWeek display the calendar week
-* @param  {boolean}  useHolidays use holidays, only german (for now)
 * @param  {boolean}  displayYear displays the year next to the Month name
-* @param  {boolean}  switches not fullt implemented!
+* @param  {boolean}  switches display switches in calendar component or not
 * @param  {string}   panelBgColor sets the background color of the panel
 * @param  {string}   textColor if autoTextColor false this must be set to a custom color
-* @param  {string}   holidayColor sets the background color of the holiday field
-* @param  {string}   holidayTextColor sets the text color of the holiday field
 *
 */
 ```