Skip to content

Commit 4cb581b

Browse files
committed
Edit README.md
Add issue_template file
1 parent cf72940 commit 4cb581b

File tree

11 files changed

+66
-14
lines changed

11 files changed

+66
-14
lines changed

ISSUE_TEMPLATE.md

Whitespace-only changes.

README.md

Lines changed: 57 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Material Dashboard - Free Bootstrap Material Design Admin](http://demos.creative-tim.com/material-dashboard/examples/dashboard.html)
1+
# [Material Dashboard](http://demos.creative-tim.com/material-dashboard/examples/dashboard.html) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=Material%20Dashboard%20by%20Creative%20Tim&url=https%3A%2F%2Fdemos.creative-tim.com%2Fmaterial-dashboard%2Fexamples%2Fdashboard.html&via=CreativeTim)
22

33
![alt text](http://s3.amazonaws.com/creativetim_bucket/products/50/original/opt_md_thumbnail.jpg "Material Dashboard Free")
44

@@ -19,11 +19,33 @@ We are very excited to share this dashboard with you and we look forward to hear
1919

2020
You can find the Github Repo here.
2121

22-
## Links:
22+
## Table of Contents
2323

24-
+ [Live Preview](http://demos.creative-tim.com/material-dashboard/examples/dashboard.html)
25-
+ [Material Kit - For Front End Development](http://www.creative-tim.com/product/material-kit?ref=github-md-free)
26-
+ [Material Dashboard PRO](http://www.creative-tim.com/product/material-dashboard-pro?ref=github-md-free) (from $49)
24+
* [Versions](#versions)
25+
* [Demo](#demo)
26+
* [Documentation](#documentation)
27+
* [quick-start](#quick-start)
28+
* [File Structure](#file-structure)
29+
* [Browser Support](#browser-support)
30+
* [Resources](#resources)
31+
* [Reporting Issues](#reporting-issues)
32+
* [Technical Support or Questions](#technical-support-or-questions)
33+
* [Licensing](#licensing)
34+
* [Useful Links](#useful-links)
35+
36+
37+
## Versions
38+
39+
[<img src="assets/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard)
40+
[<img src="assets/github/react.svg" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard-react)
41+
[<img src="assets/github/vuejs.png" width="60" height="60" />](https://www.creative-tim.com/product/vue-material-dashboard)
42+
[<img src="assets/github/angular.png" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard-angular)
43+
44+
## Demo
45+
[Live Preview](https://demos.creative-tim.com/material-dashboard/examples/dashboard.html).
46+
47+
## Documentation
48+
The documentation for the Material Dashboard is hosted at our [website](https://demos.creative-tim.com/material-dashboard/docs/2.0/getting-started/introduction.html).
2749

2850
## Quick start
2951

@@ -34,7 +56,7 @@ Quick start options:
3456
- Clone the repo: `git clone https://github.com/creativetimofficial/material-dashboard.git`.
3557

3658

37-
### What's included
59+
## File Structure
3860

3961
Within the download you'll find the following directories and files:
4062

@@ -63,18 +85,39 @@ material-dashboard/
6385
6486
```
6587

66-
### Version logs
88+
## Browser Support
89+
90+
At present, we officially aim to support the last two versions of the following browsers:
91+
92+
<img src="assets/github/chrome.png" width="64" height="64">
93+
<img src="assets/github/firefox.png" width="64" height="64">
94+
<img src="assets/github/edge.png" width="64" height="64">
95+
<img src="assets/github/safari.png" width="64" height="64">
96+
<img src="assets/github/opera.png" width="64" height="64">
97+
98+
99+
## Resources
100+
- Demo: https://demos.creative-tim.com/material-dashboard/examples/dashboard.html
101+
- Download Page: https://www.creative-tim.com/product/material-dashboard
102+
- Documentation: https://demos.creative-tim.com/material-dashboard/docs/2.0/getting-started/introduction.html
103+
- License Agreement: https://www.creative-tim.com/license
104+
- Support: https://www.creative-tim.com/contact-us
105+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-dashboard/issues)
106+
- [Material Kit - For Front End Development](http://www.creative-tim.com/product/material-kit?ref=github-md-free)
107+
- [Material Dashboard PRO](http://www.creative-tim.com/product/material-dashboard-pro?ref=github-md-free) (from $49)
108+
109+
## Reporting Issues
110+
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:
67111

68-
V1.0.0 21 Sept, 2016 - Initial Release
112+
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/).
113+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
114+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
69115

70-
V1.1.0 10 Nov, 2016 - New Page Added
71-
- fix link in documentation
72-
- for those who want to upsell inside their dashboard we added a new page "Upgrade to PRO" with a pricing and options table
116+
## Technical Support or Questions
73117

74-
V1.1.1 8 Feb 2017
75-
- switched to MIT License
118+
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.
76119

77-
### License
120+
## Licensing
78121

79122
- Copyright 2017 Creative Tim (http://www.creative-tim.com)
80123
- Licensed under MIT (https://github.com/creativetimofficial/material-dashboard/blob/master/LICENSE.md)

assets/github/angular.png

2.68 KB
Loading

assets/github/chrome.png

5.08 KB
Loading

assets/github/edge.png

1.49 KB
Loading

assets/github/firefox.png

6.24 KB
Loading

assets/github/html.png

2.32 KB
Loading

assets/github/opera.png

6.22 KB
Loading

assets/github/react.svg

Lines changed: 9 additions & 0 deletions
Loading

assets/github/safari.png

8.24 KB
Loading

assets/github/vuejs.png

3.37 KB
Loading

0 commit comments

Comments
 (0)