Update README.md

Author: evombau

README.md

@@ -1,27 +1,140 @@
-# MyWorkspace
+# Material Calendar
+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.
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.7.
+### Live demo
+[Open demo on Stackblitz](https://stackblitz.com/github/e-netsupport/material-calendar-demo)
 
-## Development server
+## Installing
+`npm i material-calendar`
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+## Usage
+app.module.ts
+``` typescript
+import { BrowserModule } from  '@angular/platform-browser';
+import { NgModule, LOCALE_ID } from  '@angular/core';
+
+import { AppComponent } from  './app.component';
+import { MaterialCalendarModule } from  'material-calendar';
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    MaterialCalendarModule
+  ],
+  providers: [
+    {provide: LOCALE_ID, useValue: 'de-DE' }
+  ],
+  bootstrap: [AppComponent]
+})
+export class AppModule { }
+```
+import the  `MaterialCalendarModule` and optional provide your location.
+In my case: `{provide:  LOCALE_ID, useValue:  'de-DE' }`
+
+In your html:
+``` html
+<calendar-panels></calendar-panels>
+```
+and you are good to go ;)
+
+>If only a one-month layout is required, the following tag can also be used:
+>``` html
+><calendar-panel [placeholderDay]="placeholder" year="2020" month="5" [config]="calendarConfig">
+></calendar-panel>
+>```
+>.
+
+
+All options are shown here:
+
+``` html
+<calendar-panels
+	[mode]="mode"
+	[placeholderDay]="placeholder"
+	year="2020"
+	month="3" 
+	monthsBefore="1"
+	monthsAfter="1"
+	[config]="calendarConfig">
+</calendar-panels>
+<!--
+	default placeholderDay = false
+	default year = current year
+	default month = current month
+	default monthsBefore = 1
+	default monthsAfter = 1
+-->
+```
+``` typescript
+import { CalendarConfig } from  'material-calendar';
+
+placeholder = false  // boolean
+mode = 'monthly'  // 'annual' | 'monthly'
+
+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%',
+    calendarWeek: true,
+    switches: false,
+}
+```
+``` javascript
+/**
+* @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  {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
+*
+*/
+```
+
+## Planned features
+
+- insert your own calendar data and render the new template
+- multiselect days optional (returns the daily span)
+
+and many more...
 
 ## Code scaffolding
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+For code scaffolding, the project can be checked out from the public repository and pull requests can be made.
+  
 
 ## Build
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+
+Run `ng build material-calendar` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Publishing
+
+After building your library with `ng build material-calendar`, go to the dist folder `cd dist/material-calendar` and run `npm publish`.
+
+  
 
 ## Running unit tests
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+  
 
-## Running end-to-end tests
+Run `ng test material-calendar` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+  
 
 ## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+For feature requests or problems, please open a ticket in the issue tracker.