Skip to content

Commit d2486f9

Browse files
author
Manu
committed
small changes in README
1 parent 1df2d29 commit d2486f9

File tree

1 file changed

+81
-24
lines changed

1 file changed

+81
-24
lines changed

README.md

Lines changed: 81 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# [Material Dashboard React - Free Material-UI Design Admin](https://creativetimofficial.github.io/material-dashboard-react/)
2-
[![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE]
1+
# [Material Dashboard React](https://demos.creative-tim.com/material-dashboard-react/#/dashboard) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fcreativetimofficial.github.io%2Fmaterial-dashboard-react&text=Material%20Dashboard%20React%20-%20Free%20Bootstrap%20Admin%20Template&original_referer=https%3A%2F%2Fdemos.creative-tim.com%2Fmaterial-dashboard-react%2F%3F_ga%3D2.10428917.198078103.1532329372-1803433978.1528781151&via=creativetim&hashtags=react%2Cmaterial-ui)
32

4-
![alt text](https://s3.amazonaws.com/creativetim_bucket/products/71/original/opt_mdr_thumbnail.jpg "Material Dashboard Free React")
3+
4+
5+
![version](https://img.shields.io/badge/version-1.4.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/material-dashboard-react.svg?maxAge=2592000)]() [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/material-dashboard-react.svg?maxAge=2592000)]() [![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/NIT-dgp/General.svg)](https://gitter.im/creative-tim/material-dashboard-react?utm_source=share-link&utm_medium=link&utm_campaign=share-link) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy)
6+
7+
![Product Gif](src/assets/github/product.gif)
58

69
Material Dashboard React is a free Material-UI Admin with a fresh, new design inspired by Google's Material Design. We are very excited to introduce our take on the material concepts through an easy to use and beautiful set of components. Material Dashboard React was built over the popular Material-UI framework.
710

@@ -18,30 +21,57 @@ We are very excited to share this dashboard with you and we look forward to hear
1821

1922
You can find the Github Repo here.
2023

21-
## Links:
24+
## Table of Contents
25+
26+
* [Versions](#versions)
27+
* [Demo](#demo)
28+
* [Quick Start](#quick-start)
29+
* [Documentation](#documentation)
30+
* [File Structure](#file-structure)
31+
* [Browser Support](#browser-support)
32+
* [Resources](#resources)
33+
* [Reporting Issues](#reporting-issues)
34+
* [Technical Support or Questions](#technical-support-or-questions)
35+
* [Licensing](#licensing)
36+
* [Useful Links](#useful-links)
37+
38+
39+
## Versions
40+
41+
[<img src="src/assets/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard)
42+
[<img src="src/assets/github/react.svg" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard-react)
43+
[<img src="src/assets/github/vuejs.png" width="60" height="60" />](https://www.creative-tim.com/product/vue-material-dashboard)
44+
[<img src="src/assets/github/angular.png" width="60" height="60" />](https://www.creative-tim.com/product/material-dashboard-angular2)
45+
46+
47+
| HTML | React | Vue | Angular |
48+
| --- | --- | --- | --- |
49+
| [![Material Dashboard HTML](src/assets/github/opt_md_thumbnail.jpg)](https://www.creative-tim.com/product/material-dashboard) | [![Material Dashboard React](src/assets/github/opt_mdr_thumbnail.jpg)](https://www.creative-tim.com/product/material-dashboard-react) | [![Vue Material Dashboard ](src/assets/github/opt_md_vue_thumbnail.jpg)](https://www.creative-tim.com/product/vue-material-dashboard) | [![Material Dashboard Angular](src/assets/github/opt_md_angular_thumbnail.jpg)](https://www.creative-tim.com/product/material-dashboard-angular2)
50+
51+
## Demo
52+
53+
| Dashboard | User Profile | Tables | Maps | Notification |
54+
| --- | --- | --- | --- | --- |
55+
| [![Start page](src/assets/github/dashboard.png)](https://demos.creative-tim.com/material-dashboard-react/#/dashboard) | [![User profile page](src/assets/github/user_profile.png)](https://demos.creative-tim.com/material-dashboard-react/#/user) | [![Tables page ](src/assets/github/tables.png)](https://demos.creative-tim.com/material-dashboard-react/#/table) | [![Maps Page](src/assets/github/maps.png)](https://demos.creative-tim.com/material-dashboard-react/#/maps) | [![Notification page](src/assets/github/notification.png)](https://demos.creative-tim.com/material-dashboard-react/#/notifications)
56+
57+
[View More](https://demos.creative-tim.com/material-dashboard-react/#/dashboard).
2258

23-
+ [Live Preview](https://creativetimofficial.github.io/material-dashboard-react/)
24-
+ [Material Dashboard HTML](http://demos.creative-tim.com/material-dashboard/examples/dashboard.html)
2559

2660
## Quick start
2761

2862
Quick start options:
2963

30-
- [Download from Github](https://github.com/creativetimofficial/material-dashboard-react/archive/master.zip).
31-
- [Download from Creative Tim](http://www.creative-tim.com/product/material-dashboard-react).
64+
- `npm i material-dashboard-react`
3265
- Clone the repo: `git clone https://github.com/creativetimofficial/material-dashboard-react.git`.
66+
- [Download from Github](https://github.com/creativetimofficial/material-dashboard-react/archive/master.zip).
67+
- [Download from Creative Tim](https://www.creative-tim.com/product/material-dashboard-react).
3368

34-
## Terminal Commands
3569

36-
1. Install NodeJs from [NodeJs Official Page](https://nodejs.org/en).
37-
2. Open Terminal
38-
3. Go to your file project
39-
4. Run in terminal: ```npm install```
40-
5. Then: ```npm start```
41-
6. Navigate to `http://localhost:3000/`
42-
7. (optional) Run in terminal `npm i -g cross-env`
70+
## Documentation
71+
The documentation for the Material Dashboard React is hosted at our [website](https://demos.creative-tim.com/material-dashboard-react/#/documentation/tutorial).
4372

44-
### What's included
73+
74+
## File Structure
4575

4676
Within the download you'll find the following directories and files:
4777

@@ -67,6 +97,7 @@ material-dashboard-react
6797
├── assets
6898
│   ├── css
6999
│   │   └── material-dashboard-react.css
100+
│   ├── github
70101
│   ├── img
71102
│   │   └── faces
72103
│   └── jss
@@ -167,9 +198,41 @@ material-dashboard-react
167198
└── UserProfile.jsx
168199
```
169200

201+
## Browser Support
202+
203+
At present, we officially aim to support the last two versions of the following browsers:
204+
205+
<img src="src/assets/github/chrome.png" width="64" height="64"> <img src="src/assets/github/firefox.png" width="64" height="64"> <img src="src/assets/github/edge.png" width="64" height="64"> <img src="src/assets/github/safari.png" width="64" height="64"> <img src="src/assets/github/opera.png" width="64" height="64">
206+
207+
208+
## Resources
209+
- Demo: https://demos.creative-tim.com/material-dashboard-react
210+
- Download Page: https://www.creative-tim.com/product/material-dashboard-react
211+
- Documentation: https://demos.creative-tim.com/material-dashboard-react/#/documentation/tutorial
212+
- License Agreement: https://www.creative-tim.com/license
213+
- Support: https://www.creative-tim.com/contact-us
214+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-dashboard-react/issues)
215+
- [Material Kit React - For Front End Development](https://www.creative-tim.com/product/material-kit-react?ref=github-mdr-free)
216+
217+
## Reporting Issues
218+
We use GitHub Issues as the official bug tracker for the Material Dashboard React. Here are some advices for our users that want to report an issue:
219+
220+
1. Make sure that you are using the latest version of the Material Dashboard React. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/).
221+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
222+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
223+
224+
## Technical Support or Questions
225+
226+
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.
227+
228+
## Licensing
229+
230+
- Copyright 2018 Creative Tim (https://www.creative-tim.com)
231+
- Licensed under MIT (https://github.com/creativetimofficial/material-dashboard-react/blob/master/LICENSE.md)
232+
170233
## Useful Links
171234

172-
More products from Creative Tim: <https://www.creative-tim.com/bootstrap-themes>
235+
More products from Creative Tim: <https://www.creative-tim.com/products>
173236

174237
Tutorials: <https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w>
175238

@@ -188,9 +251,3 @@ Dribbble: <https://dribbble.com/creativetim>
188251
Google+: <https://plus.google.com/+CreativetimPage>
189252

190253
Instagram: <https://instagram.com/creativetimofficial>
191-
192-
[CHANGELOG]: ./CHANGELOG.md
193-
194-
[LICENSE]: ./LICENSE.md
195-
[version-badge]: https://img.shields.io/badge/version-1.3.0-blue.svg
196-
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg

0 commit comments

Comments
 (0)