Skip to content

Commit 47f3a24

Browse files
committed
More info on README
1 parent 8955318 commit 47f3a24

File tree

1 file changed

+32
-17
lines changed

1 file changed

+32
-17
lines changed

README.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,53 @@
1-
# tempusdominus-bootstrap
1+
# Bootstrap4 Datetimepicker
22

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

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

7-
The original README.md follows below this paragraph.
7+
# Todo
88

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

12-
# Version 5
13-
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.
17+
# Requirements
1418

15-
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.
19+
- jQuery
20+
- Bootstrap 4
21+
- momment.js
1622

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

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

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

31+
# Credits
32+
33+
This package is a fork of the excellent but discontinued [tempusdominus/bootstrap-4](https://github.com/tempusdominus/bootstrap-4) repo.
34+
35+
# License
36+
37+
MIT. Feel free to use for personal and comercial.
2438

2539
## Submitting Issues
40+
2641
If you have issues, please check the following first:
42+
2743
* Have you read the docs?
2844
* Do you have the latest version of momentjs?
2945
* Do you have the latest version of jQuery?
3046
* Please test and/or fork [this jsfiddle](https://jsfiddle.net/Eonasdan/bdxss6m8/) with an example of your issue before you post an issue here.
3147
* Please indicate which version of the picker you are using (this can be found at the top of any included file)
3248

33-
## Where do you use this?
34-
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`.
35-
3649
## Priority support is available at an hourly rate.
3750

38-
If you have an urgent request, bug or need installation help, please contact me at `me at eonasdan dot com` for a quote.
51+
If you have an urgent request, bug or need installation help, please contact me at `brunocassol at gmail dot com` for a quote.
52+
53+
Alternatively, you might want to contact the original author of the library on `me at eonasdan dot com` for a quote.

0 commit comments

Comments
 (0)