From 53e573abbe9bedccd821067ddce004c3b1c2d01c Mon Sep 17 00:00:00 2001 From: Josh Sommer Date: Wed, 5 Jun 2019 20:50:22 -0400 Subject: [PATCH] Updating readme --- README.md | 75 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 20e97e5..5c287c7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # ngx-datetime-picker + ## Date time picker that falls back to native HTML5 components on mobile ![image](https://cloud.githubusercontent.com/assets/13574057/24919884/1d00adac-1eb3-11e7-85b6-d221058d0b03.png) -* No jQuery or other external dependencies. -* 3 seperate components for Date Time, Date, and Time picker -* When being used on a mobile or touch devices it falls back to html5 inputs of date, datetime-local, and time +- No jQuery or other external dependencies. +- 3 seperate components for Date Time, Date, and Time picker +- When being used on a mobile or touch devices it falls back to html5 inputs of date, datetime-local, and time [![npm](https://img.shields.io/npm/v/ngx-datetime-picker.svg)](https://www.npmjs.com/package/ngx-datetime-picker) [![npm](https://img.shields.io/npm/dt/ngx-datetime-picker.svg?label=npm%20downloads)](https://www.npmjs.com/package/ngx-datetime-picker) @@ -24,23 +25,18 @@ import { DateTimePickerModule} from 'ngx-datetime-picker'; ``` ```html - - + -Additional options for each picker: - [disableButton]="false" (default) - [disableInput]="false" (default) - [disablePicker]="false" (default) - [doNotCloseOnDateSet]="false" (default) - -Additional options for ngx-date-picker and ngx-datetime-picker: - [min]="null" (default) - [max]="null" (default) - +Additional options for each picker: [disableButton]="false" (default) +[disableInput]="false" (default) [disablePicker]="false" (default) +[doNotCloseOnDateSet]="false" (default) Additional options for ngx-date-picker +and ngx-datetime-picker: [min]="null" (default) [max]="null" (default) ``` ## CSS @@ -61,32 +57,33 @@ _If_ you are using angular-cli the css can be added to your angular-cli.json ### Work flow -* Clone repository to your machine. -* Run `npm run setup` to prepare the project -* Live edit mode with `npm run serve`. -* Run tests with watcher with `npm run test`. -* Run tests without a watcher with `npm run test.once`. -* Prepare for distrabution with `npm run dist` (note you man need to also run `tsc index.ts` if you have updated the exported values.) -* Test a demo project using the exported ngModule with `npm run demo` -* Sass files are compiled locally using [Koala](http://koala-app.com/). -* Set Koala to watch `date.component.scss` and compile it to `ngx-datetimepicker > src > assets` as `ngx-datetime-picker.css`. - -* *Optionally* you can use https://github.com/angular-buch/angular-cli-ghpages to publish the demo install to github pages. by first running `npm run demo`, then by going into your demo directory with `cd demo` and from there you can copy and past the two commands to publish to github pages. - ``` - ng build --prod --aot --base-href "https://renovosolutions.github.io/ngx-datetimepicker/" - ``` - then - ``` - ngh --repo=https://github.com/renovosolutions/ngx-datetimepicker.git - ``` - _note this will publish to the `gh-pages` branch and you wil need to authenicate again_ +- Clone repository to your machine. +- Run `npm run setup` to prepare the project +- Live edit mode with `npm run serve`. +- Run tests with watcher with `npm run test`. +- Run tests without a watcher with `npm run test.once`. +- Prepare for distrabution with `npm run dist` (note you man need to also run `tsc index.ts` if you have updated the exported values.) +- Test a demo project using the exported ngModule with `npm run demo` +- Sass files are compiled locally using [Koala](http://koala-app.com/). +- Set Koala to watch `date.component.scss` and compile it to `ngx-datetimepicker > src > assets` as `ngx-datetime-picker.css`. + +- _Optionally_ you can use https://github.com/angular-buch/angular-cli-ghpages to publish the demo install to github pages. by first running `npm run demo`, then by going into your demo directory with `cd demo` and from there you can copy and past the two commands to publish to github pages. + ``` + ng build --prod --aot --base-href "https://renovosolutions.github.io/ngx-datetimepicker/" + ``` + then + ``` + ngh --repo=https://github.com/renovosolutions/ngx-datetimepicker.git + ``` + _note this will publish to the `gh-pages` branch and you wil need to authenicate again_ + ### Requirements -* angular-cli 1.0.0-beta.28.3 or higher -* node 6.9.0 or higher +- angular-cli 1.0.0-beta.28.3 or higher +- node 6.9.0 or higher ### Contributors -[TheOriginalJosh](https://github.com/TheOriginalJosh) | [BrentWMiller](https://github.com/BrentWMiller)| [SFarageNIS](https://github.com/SFarageNIS)| [Marco Mantovani](https://github.com/TheLand) | [Jojie Palahang](https://github.com/JojiePalahang)| [Sam Graber](https://github.com/SamGraber)| [alecrem](https://github.com/alecrem) -:---: |:---: |:---: |:---: |:---: |:---: |:---: | -[Josh Sommer](https://github.com/TheOriginalJosh) |[Brent Miller](https://github.com/BrentWMiller) |[Steven Farage](https://github.com/SFarageNIS)|[Marco Mantovani](https://github.com/TheLand) | [Jojie Palahang](https://github.com/JojiePalahang)| [Sam Graber](https://github.com/SamGraber) | [Alejandro Cremades](https://github.com/alecrem) +| [JoshDSommer](https://github.com/JoshDSommer) | [BrentWMiller](https://github.com/BrentWMiller) | [SFarageNIS](https://github.com/SFarageNIS) | [Marco Mantovani](https://github.com/TheLand) | [Jojie Palahang](https://github.com/JojiePalahang) | [Sam Graber](https://github.com/SamGraber) | [alecrem](https://github.com/alecrem) | +| :-----------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: | +| [Josh Sommer](https://github.com/JoshDSommer) | [Brent Miller](https://github.com/BrentWMiller) | [Steven Farage](https://github.com/SFarageNIS) | [Marco Mantovani](https://github.com/TheLand) | [Jojie Palahang](https://github.com/JojiePalahang) | [Sam Graber](https://github.com/SamGraber) | [Alejandro Cremades](https://github.com/alecrem) |