Skip to content

Commit e2088cf

Browse files
authored
Update README.md
1 parent a83fd7d commit e2088cf

1 file changed

Lines changed: 105 additions & 106 deletions

File tree

README.md

Lines changed: 105 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,162 +1,161 @@
1-
# [Material Kit - Free Bootstrap 4 UI Kit](http://demos.creative-tim.com/material-kit/index.html)
1+
# [Material Kit](https://demos.creative-tim.com/material-kit/index.html) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/home?status=Material%20Kit%20is%20a%20Free%20Bootstrap%204%20UI%20Kit%20%E2%9D%A4%EF%B8%8F%0Ahttps%3A//demos.creative-tim.com/material-kit/index.html%20%23bootstrap%20%23material%20%23design%20%23uikit%20%23freebie%20%20via%20%40CreativeTim)
22

3-
![alt text](https://s3.amazonaws.com/creativetim_bucket/products/38/original/opt_mk_thumbnail.jpg "Material Kit Free")
3+
4+
![version](https://img.shields.io/badge/version-2.0.3-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/material-kit.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-kit/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/material-kit.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-kit/issues?q=is%3Aissue+is%3Aclosed) [![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/NIT-dgp/General.svg)](https://gitter.im/creative-tim-general/Lobby) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy)
5+
6+
7+
![Product Gif](https://s3.amazonaws.com/creativetim_bucket/github/gif/material-kit-free.gif)
48

59
Material Kit is a Free Bootstrap 4 UI Kit with a fresh, new design inspired by Google's material design. You asked for it, so we built it. It's a great pleasure to introduce to you the material concepts in an easy to use and beautiful set of components. Along with the restyling of the Bootstrap elements, you will find three fully-coded example pages, to help you design your next project.
610

711
Material Kit makes use of light, surface and movement. It uses a deliberate color choice, edge-to-edge imagery and large scale typography. The general layout resembles sheets of paper following multiple different layers, so that the depth and order is obvious. The navigation stays mainly on the left and the actions on the right.
812

913
This new design has elements that have been the result of research regarding ink and paper and the way objects and materials interact in real life. The result is a beautiful and consistent set of elements that can get you started with your next project. Material Kit is a great tool if you are looking to create a web presence for your Android application and need to be consistent, leaving the impression of visually similar elements. It is also a great resource in its own right, looking gorgeous and helping you build your web pages.
1014

11-
Material Kit is based on the Github Repo from Fez (http://fezvrasta.github.io/bootstrap-material-design/) who did an amazing job creating the backbone for the material effects, animations and transitions. Big thanks to his team for their forward thinking efforts.
15+
Material Kit is based on the Github Repo from Fezvrasta (http://fezvrasta.github.io/bootstrap-material-design/) who did an amazing job creating the backbone for the material effects, animations and transitions. Big thanks to his team for their forward thinking efforts.
1216

13-
## Links:
1417

15-
+ [Live Preview](http://demos.creative-tim.com/material-kit/index.html)
16-
+ [Material Kit PRO](http://demos.creative-tim.com/material-kit-pro/presentation.html) (from $79)
18+
## Table of Contents
19+
20+
* [Versions](#versions)
21+
* [Demo](#demo)
22+
* [Quick Start](#quick-start)
23+
* [Documentation](#documentation)
24+
* [File Structure](#file-structure)
25+
* [Browser Support](#browser-support)
26+
* [Resources](#resources)
27+
* [Reporting Issues](#reporting-issues)
28+
* [Technical Support or Questions](#technical-support-or-questions)
29+
* [Licensing](#licensing)
30+
* [Useful Links](#useful-links)
31+
32+
33+
34+
## Versions
35+
36+
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/material-kit)[<img src="https://s3.amazonaws.com/creativetim_bucket/github/react.svg" width="60" height="60" />](https://www.creative-tim.com/product/material-kit-react)
1737

18-
## Quick start
1938

20-
Quick start options:
39+
| HTML | React |
40+
| --- | --- |
41+
| [![Material Kit HTML](https://s3.amazonaws.com/creativetim_bucket/products/38/thumb/opt_mk_thumbnail.jpg)](https://www.creative-tim.com/product/material-kit) | [![Material Kit React](https://s3.amazonaws.com/creativetim_bucket/products/83/thumb/opt_mk_react_thumbnail.jpg)](https://www.creative-tim.com/product/material-kit-react)
42+
43+
44+
45+
## Demo
46+
47+
- [Index Page](https://demos.creative-tim.com/material-kit/index.html)
48+
- [Buttons Section](https://demos.creative-tim.com/material-kit/index.html#buttons)
49+
- [Navigation Section](https://demos.creative-tim.com/material-kit/index.html#navigation)
50+
- [Notifications Section](https://demos.creative-tim.com/material-kit/index.html#notifications)
51+
- [User profile page](https://demos.creative-tim.com/material-kit/examples/profile-page.html)
52+
- [Landing page](https://demos.creative-tim.com/material-kit/examples/landing-page.html)
53+
54+
[View More](https://demos.creative-tim.com/material-kit/index.html).
55+
56+
57+
## Quick start
2158

22-
- [Download from Github](https://github.com/creativetimofficial/material-kit.git).
59+
- [Download from Github](https://github.com/creativetimofficial/material-kit/archive/master.zip).
2360
- [Download from Creative Tim](http://www.creative-tim.com/product/material-kit).
61+
- Install with [Bower](https://bower.io/): ```bower install material-kit```.
2462
- Clone the repo: `git clone https://github.com/creativetimofficial/material-kit.git`.
2563

2664

27-
### What's included
65+
## Documentation
66+
The documentation for the Material Kit is hosted at our [website](https://demos.creative-tim.com/material-kit/docs/2.0/getting-started/introduction.html).
2867

68+
69+
## File Structure
2970
Within the download you'll find the following directories and files:
3071

3172
```
3273
material-kit/
3374
├── CHANGELOG.md
75+
├── LICENSE.md
76+
├── README.md
3477
├── assets
35-
│ ├── demo
78+
│ ├── assets-for-demo
3679
│ ├── css
3780
│ │ ├── material-kit.css
3881
│ │ ├── material-kit.css.map
3982
│ │ └── material-kit.min.css
4083
│ ├── img
4184
│ ├── js
85+
│ │ ├── bootstrap-material-design.js
86+
│ │ ├── bootstrap-material-design.min.js
4287
│ │ ├── core
43-
│ │ │ ├── bootstrap-material-design.min.js
4488
│ │ │ ├── jquery.min.js
4589
│ │ │ └── popper.min.js
4690
│ │ ├── material-kit.js
47-
│ │ ├── material-kit.js.map
4891
│ │ ├── material-kit.min.js
4992
│ │ └── plugins
5093
│ │ ├── bootstrap-datetimepicker.min.js
94+
│ │ ├── jasny-bootstrap.min.js
5195
│ │ ├── moment.min.js
5296
│ │ └── nouislider.min.js
5397
│ └── scss
54-
│ ├── material-kit
55-
│ └── material-kit.scss
98+
│ ├── bootstrap
99+
│ ├── core
100+
│ ├── material-kit.scss
101+
│ └── plugins
102+
├── bower.json
56103
├── docs
57-
│ └── documentation.html
104+
│ └── documentation-free.html
58105
├── examples
59106
│ ├── landing-page.html
60107
│ ├── profile-page.html
61108
│ └── signup-page.html
62-
├── gulpfile.js
63-
├── index.html
64-
└── package.json
109+
└── index.html
65110
```
66111

67-
### Version logs
68-
69-
## [2.0.3] 2018-05-07
70-
### BugFixing
71-
- Scss cleaned and fixed issue when compiling
72-
- Archive cleaned
73-
- Other small bug fixing
74-
75-
## [2.0.2] 2018-02-13
76-
### Improvements, Bootstrap 4.0.0 Final Included
77-
- Reestablish the routes/folder for images
78-
79-
## [2.0.1] 2018-01-31
80-
### Bug fixing, Improvements
81-
- Added two plugins in Documentation
82-
- Included gulp task that opens the project in browser
83-
- Reestablish the routes for some Documentation Components
84-
- responsive issue fixed for carousel
85-
86-
## [2.0.0] 2018-01-12
87-
### Bootstrap 4 update
88-
- Core base code on Bootstrap 4
89-
- Documentation code base written from scratch
90-
- Speed optimizations
91-
- Class changes : .card-block to .card-body
92-
- .navbar-toggleable-* to .navbar-expand-*
93-
- .hidden-*-down to .d-none .d-*-block
94-
- .hidden-*-up to .d-*-none
95-
- .checkbox to .form-check
96-
- .radio to .form-check
97-
- more class changes here:https://medium.com/@lukaszholeczek/how-to-upgrade-bootstrap-4-alpha-6-to-bootstrap-4-beta-d43b4210f2a3
98-
- Bug fixes for responsive devices
99-
- Small changes for components
100-
101-
## [1.2.1] 2017-11-09
102-
### BugFixing
103-
- fixed parallax page scroll
104-
- fixed cards from `ecommerce.html` page
105-
106-
## [1.2.0] 2017-09-13
107-
### BugFixing
108-
- jQuery library update to the latest version
109-
- removed atv-img-animation.js library ( multiple problems with the browsers )
110-
- fixed rotating card system for IE, changed rotating cards with raised image with regular cards with background image or plain cards
111-
- bootstrap-selectpicker.js updated to the latest version
112-
113-
## [1.1.1] 2017-05-22
114-
### BugFixing
115-
- fixed problem with Morphing Cards(rotating manual and auto) and Perspective Cards when images were loading later than the javascript
116-
117-
## [1.1.0] 2017-04-14
118-
### BugFixing, Plugins Updates, New Cards (HTML Version)
119-
- v1.1.0 14 Apr, 2017 -
120-
- Bootstrap v3.3.7
121-
- Bootstrap DateTimePicker v4.17.45
122-
- Replace Bootstrap SelectPicker v1.11.2
123-
- Replace Tags with Bootstrap TagsInput v0.8.0
124-
- jQuery.Flexisel v2.1.0
125-
- NoUiSlider v9.0.0
126-
- jQuery v3.1.1
127-
- moment.js v2.14.1
128-
- Added new cards
129-
- Added 3D animation effect for images on cards(atvImg library)
130-
- Added DynamicShadows
131-
- Added New rotating cards
132-
- Added Ecommerce Page
133-
- Bug fixing
134-
- Documentation Updates
135-
- Added simple input example
136-
137-
IMPORTANT! If you migrate from V1.0.0 to V1.1.0 please make sure your replace the '.content' class inside each card with '.card-content', we've made this adjustment for a better control of the content that is inside a card. Sorry for the inconvenience.
138-
139-
## [1.0.0] 2016-06-15
140-
### Initial Release
141-
142-
143-
### License
144-
145-
- Copyright 2018 Creative Tim (http://www.creative-tim.com)
146-
- Licensed under MIT (https://github.com/timcreative/material-kit/blob/master/LICENSE.md)
147112

113+
## Browser Support
114+
115+
At present, we officially aim to support the last two versions of the following browsers:
116+
117+
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
118+
119+
120+
121+
## Resources
122+
- Demo: <https://demos.creative-tim.com/material-kit/index.html>
123+
- Download Page: <https://www.creative-tim.com/product/material-kit>
124+
- Documentation: <https://demos.creative-tim.com/material-kit/docs/2.0/getting-started/introduction.html>
125+
- License Agreement: <https://www.creative-tim.com/license>
126+
- Support: <https://www.creative-tim.com/contact-us>
127+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-kit/issues)
128+
## Reporting Issues
129+
130+
We use GitHub Issues as the official bug tracker for the Material Dashboard. Here are some advices for our users that want to report an issue:
131+
132+
1. Make sure that you are using the latest version of the Material Dashboard. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).
133+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
134+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
148135

149-
## Useful Links
150136

151-
More products from Creative Tim: <http://www.creative-tim.com/products>
137+
## Technical Support or Questions
152138

153-
Tutorials: <https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w>
139+
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue.
154140

155-
Freebies: <http://www.creative-tim.com/products>
156141

157-
Affiliate Program (earn money): <http://www.creative-tim.com/affiliates/new>
158142

159-
Social Media:
143+
## Licensing
144+
145+
- Copyright 2018 Creative Tim (https://www.creative-tim.com/)
146+
147+
- Licensed under MIT (https://github.com/creativetimofficial/material-kit/blob/master/LICENSE.md)
148+
149+
150+
151+
## Useful Links
152+
153+
- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim
154+
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
155+
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim
156+
- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money)
157+
158+
##### Social Media
160159

161160
Twitter: <https://twitter.com/CreativeTim>
162161

@@ -166,4 +165,4 @@ Dribbble: <https://dribbble.com/creativetim>
166165

167166
Google+: <https://plus.google.com/+CreativetimPage>
168167

169-
Instagram: <https://instagram.com/creativetimofficial>
168+
Instagram: <https://www.instagram.com/CreativeTimOfficial>

0 commit comments

Comments
 (0)