Skip to content

Commit

Permalink
Add screenshot, what's changed and roard map
Browse files Browse the repository at this point in the history
  • Loading branch information
DucThanhNguyen authored Apr 10, 2018
1 parent 3611c57 commit 2092f92
Showing 1 changed file with 74 additions and 4 deletions.
78 changes: 74 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,82 @@ Introduction

Check out the live preview now and see for yourself.

## Live Preview
[https://ducthanhnguyen.github.io/MaterialAdminLTE](https://ducthanhnguyen.github.io/MaterialAdminLTE)
## Demo
Live preview: [https://ducthanhnguyen.github.io/MaterialAdminLTE](https://ducthanhnguyen.github.io/MaterialAdminLTE)
Screenshot:
<img src="https://raw.githubusercontent.com/DucThanhNguyen/MaterialAdminLTE/gh-pages/documentation/MaterialAdminLTE_Dashboard.JPG">

## AdminLTE Documentation & Installation Guide
Visit the [online documentation](https://adminlte.io/docs) for the most
updated guide.
Offline documentation is avaiable in the source code at the folder: [/documentation/index.html](https://github.com/DucThanhNguyen/MaterialAdminLTE/blob/master/documentation/index.html)
Visit the [online documentation](https://adminlte.io/docs) for the most updated guide.

## What's changed in AdminLTE
We tried to make minimal change to the original AdminLTE so that it's easier for upgrading to the new version of it
Here are files and folder that's added to the original source code:
```
MaterialAdminLTE/
├── build/
| ├── bootstrap-material-design-less/*
| | └── plugins/*
| └── material-less/
| ├── bootstrap-social.less
| ├── MaterialAdminLTE.less
| └── skins
| ├── all-md-skins.less
| ├── skin-md-black.less
| ├── skin-md-black-light.less
| ├── skin-md-blue.less
| ├── skin-md-blue-light.less
| ├── skin-md-green.less
| ├── skin-md-green-light.less
| ├── skin-md-purple.less
| ├── skin-md-purple-light.less
| ├── skin-md-red.less
| ├── skin-md-red-light.less
| ├── skin-md-yellow.less
| └── skin-md-yellow-light.less
└── build/
├── css/
| ├── bootstrap-material-design.css
| ├── MaterialAdminLTE.css
| ├── ripples.css
| └── skins
| ├── all-md-skins.css
| ├── skin-md-black.css
| ├── ...
| └── skin-md-yellow-light.css
├── img/
| └── patterns/
| ├── user-panel-bg_blue.jpg
| ├── ...
| └── user-panel-bg_yellow.jpg
└── js/
├── material.js
└── ripples.js
```
In html pages of AdminLTE, we added following lines of code
```
<!-- Material Design -->
<link rel="stylesheet" href="dist/css/bootstrap-material-design.min.css">
<link rel="stylesheet" href="dist/css/ripples.min.css">
<link rel="stylesheet" href="dist/css/MaterialAdminLTE.min.css">
<!-- AdminLTE Material Skins. Choose a skin from the css/skins
folder instead of downloading all of them to reduce the load. -->
<link rel="stylesheet" href="dist/css/skins/all-md-skins.min.css">
</head>
```
```
<!-- Material Design -->
<script src="dist/js/material.min.js"></script>
<script src="dist/js/ripples.min.js"></script>
<script>
$.material.init();
</script>
</body>
```
## Roard map
- Upgrade to **AdminLTE 3** with **Bootstrap 4** as soon as the stable version of AdminLTE is released
- Upgrade to **[Material Design for Bootstrap 4](https://fezvrasta.github.io/bootstrap-material-design/)**

## License
MaterialAdminLTE is an open source project that is licensed under [MIT](http://opensource.org/licenses/MIT).

0 comments on commit 2092f92

Please sign in to comment.