AdminLTE/README.md

58 lines
3.4 KiB
Markdown
Raw Normal View History

2015-02-22 19:12:01 +00:00
Introduction
============
2014-10-31 01:31:01 +00:00
![Bower version](https://img.shields.io/bower/v/adminlte.svg)
[![npm version](https://img.shields.io/npm/v/admin-lte.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
[![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte)
2015-08-04 21:56:56 +00:00
**AdminLTE** -- is a fully responsive admin template. Based on **[Bootstrap 3](https://github.com/twbs/bootstrap)** framework. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. Check out the live preview now and see for yourself.
2014-02-01 16:15:26 +00:00
2017-05-17 23:23:05 +00:00
**Download & Preview on [AdminLTE.IO](https://adminlte.io)**
2017-02-26 21:12:36 +00:00
### Looking for Premium Templates?
2017-05-17 23:23:05 +00:00
**AdminLTE.IO just opened a new premium templates website. Hand picked to ensure the best quality and the most affordable prices. Visit https://themequarry.com for more information.**
2014-04-02 22:52:34 +00:00
2017-03-04 17:11:59 +00:00
## Documentation & Installation Guide
2017-05-17 23:23:05 +00:00
Visit the [online documentation](https://adminlte.io/docs) for the most
2017-02-26 21:13:34 +00:00
updated guide.
2015-02-22 19:12:01 +00:00
2017-05-18 12:22:52 +00:00
!["AdminLTE Presentation"](https://adminlte.io/AdminLTE2.png "AdminLTE Presentation")
2015-02-22 19:12:01 +00:00
2017-02-26 21:12:36 +00:00
### Contribution
2015-02-22 19:12:01 +00:00
Contribution are always **welcome and recommended**! Here is how:
- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
2015-03-04 16:12:30 +00:00
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/AdminLTE.git```
2015-02-22 19:12:01 +00:00
- Make your changes
- Create a pull request
2015-02-23 00:59:19 +00:00
#### Contribution Requirements:
2017-05-17 23:23:05 +00:00
- When you contribute, you agree to give a non-exclusive license to AdminLTE.IO to use that contribution in any context as we (AdminLTE.IO) see appropriate.
2015-02-22 19:12:01 +00:00
- If you use content provided by another party, it must be appropriately licensed using an [open source](http://opensource.org/licenses) license.
- Contributions are only accepted through Github pull requests.
- Finally, contributed code must work in all supported browsers (see above for browser support).
2017-02-26 21:12:36 +00:00
### License
2017-05-17 23:23:05 +00:00
AdminLTE is an open source project by [AdminLTE.IO](https://adminlte.io) that is licensed under [MIT](http://opensource.org/licenses/MIT). AdminLTE.IO
reserves the right to change the license of future releases. Wondering what you can or can't do? View the [license guide](https://adminlte.io/docs/license).
2015-02-22 19:12:01 +00:00
2017-02-26 21:12:36 +00:00
### Legacy Releases
2017-05-17 23:23:05 +00:00
AdminLTE 1.x can be easily upgraded to 2.x using [this guide](https://adminlte.io/themes/AdminLTE/documentation/index.html#upgrade), but if you intend to keep using AdminLTE 1.x, you can download the latest release from the [releases](https://github.com/almasaeed2010/AdminLTE/releases) section above.
2015-02-23 00:55:00 +00:00
2017-02-26 21:12:36 +00:00
### Change log
2017-06-27 20:11:06 +00:00
**For the most recent change log, visit the [releases page](https://github.com/almasaeed2010/AdminLTE/releases) or the [changelog file](https://github.com/almasaeed2010/AdminLTE/blob/master/changelog.md).** We will add detailed release notes to each new release.
2014-04-06 00:12:30 +00:00
2017-02-26 21:12:36 +00:00
### Image Credits
- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)
- [Graphicsfuel](http://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/)
- [Pickaface](http://pickaface.net/)
- [Unsplash](https://unsplash.com/)
- [Uifaces](http://uifaces.com/)
2015-02-22 19:12:01 +00:00
2017-02-26 21:12:36 +00:00
### Donations
2015-02-22 19:12:01 +00:00
Donations are **greatly appreciated!**
2014-02-01 16:15:26 +00:00
2015-02-23 00:55:00 +00:00
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "AdminLTE Presentation")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=629XCUSXBHCBC "Donate")