Skip to content

Commit

Permalink
More info on README
Browse files Browse the repository at this point in the history
  • Loading branch information
brunocassol committed Jan 10, 2021
1 parent 8955318 commit 47f3a24
Showing 1 changed file with 32 additions and 17 deletions.
49 changes: 32 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,53 @@
# tempusdominus-bootstrap
# Bootstrap4 Datetimepicker

This package is a fork of the original [tempusdominus/bootstrap-4](https://github.com/tempusdominus/bootstrap-4) repo.
This is a fork of the excellent but discontinued [tempusdominus/bootstrap-4](https://github.com/tempusdominus/bootstrap-4).

This fork includes bugfixes, new features, and comes with updated NPM packages ([JSFiddle](https://jsfiddle.net/nmocbjLf/1/)).
The goal is to mantain it with comunity help by applying small improvements and bug fixes since we need the component for professional projects.

The original README.md follows below this paragraph.
# Todo

# Tempus Dominus Bootstrap 4
![GitHub version](https://badge.fury.io/gh/tempusdominus%2Fbootstrap-3-datetimepicker.png)
1. Take a look and merge PRs from [tempusdominus/bootstrap-4](https://github.com/tempusdominus/bootstrap-4) in this repo.
1. Setup github page with demos.
1. Setup npm package.
1. Document usage here on README.
1. Setup CDN so people can use it easily.
1. Switch from discontinued [momment.js](https://momentjs.com/docs/#/-project-status/) to another date library. Perhaps [Day,js](https://github.com/iamkun/dayjs)?
1. Cleanup project if needed. Simplify.

# Version 5
This is the Bootstrap 4 component of the new Version 5. This is a "scorched earth" version and there are **a lot** of breaking changes.
# Requirements

The new picker under the "Tempus Dominus" brand will be completely modular. The goal is to separate the core functions into its own library with specific modules for Bootstrap 3, Bootstrap 4, and possibly other UI frameworks.
- jQuery
- Bootstrap 4
- momment.js

This new version has been completely rewritten in ES6 and uses Babel to transpile the code down.
# Installation

# Issues
The issue tracker is solely for bug reports. Please ask your questions on Stack Overflow.
- Make sure you have the requirements. Then include these two files on your page:
- https://github.com/brunocassol/bootstrap4-datetimepicker/blob/main/build/css/tempusdominus-bootstrap-4.min.css
- https://github.com/brunocassol/bootstrap4-datetimepicker/blob/main/build/js/tempusdominus-bootstrap-4.min.js

New issues that are requests for "how do I.." will be closed and redirected to Stack Overflow.
I'll setup Github pages when I have the time.

# Credits

This package is a fork of the excellent but discontinued [tempusdominus/bootstrap-4](https://github.com/tempusdominus/bootstrap-4) repo.

# License

MIT. Feel free to use for personal and comercial.

## Submitting Issues

If you have issues, please check the following first:

* Have you read the docs?
* Do you have the latest version of momentjs?
* Do you have the latest version of jQuery?
* Please test and/or fork [this jsfiddle](https://jsfiddle.net/Eonasdan/bdxss6m8/) with an example of your issue before you post an issue here.
* Please indicate which version of the picker you are using (this can be found at the top of any included file)

## Where do you use this?
I'd love to know if your public site is using this plugin and list your logo on the documentation site. Please email me `me at eonasdan dot com`.

## Priority support is available at an hourly rate.

If you have an urgent request, bug or need installation help, please contact me at `me at eonasdan dot com` for a quote.
If you have an urgent request, bug or need installation help, please contact me at `brunocassol at gmail dot com` for a quote.

Alternatively, you might want to contact the original author of the library on `me at eonasdan dot com` for a quote.

0 comments on commit 47f3a24

Please sign in to comment.