From 1e10243513f66f52d211f4cb7488a592b0e0b8be Mon Sep 17 00:00:00 2001 From: Daniel <50356015+danny007in@users.noreply.github.com> Date: Fri, 14 May 2021 06:53:59 +0530 Subject: [PATCH] Update README.md --- README.md | 100 +++++++----------------------------------------------- 1 file changed, 12 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 29f8cb444..505f7ea7b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -# [AdminLTE - Bootstrap 4 Admin Dashboard](https://adminlte.io) +# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io) [![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte) [![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte) [![cdn version](https://data.jsdelivr.com/v1/package/npm/admin-lte/badge)](https://www.jsdelivr.com/package/npm/admin-lte) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) -**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4.6](https://getbootstrap.com/)** framework and also the JS/jQuery plugin. +**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 5](https://getbootstrap.com/)** framework and also the JavaScript plugins. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. -**Preview on [AdminLTE.io](https://adminlte.io/themes/v3)** - ## Looking for Premium Templates? AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable @@ -21,79 +19,6 @@ prices. Visit for more information. SCSS has been used to increase code customizability. ## Quick start -There are multiple ways to install AdminLTE. - -### Download & Changelog: -Always Recommended to download from GitHub latest release [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/releases/latest) for bug free and latest features.\ -Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog.\ -Legacy Releases are [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1). - -## Stable release -### Grab from [jsdelivr](https://www.jsdelivr.com/package/npm/admin-lte) CDN: -_**Important Note**: You needed to add separately cdn links for plugins in your project._ -```html - -``` -```html - -``` -### Using The Command Line: -_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._ -#### Via npm -```bash -npm install admin-lte@^3.1 --save -``` -#### Via Yarn -```bash -yarn add admin-lte@^3.1 -``` -#### Via Composer -```bash -composer require "almasaeed2010/adminlte=~3.1" -``` -#### Via Git -```bash -git clone https://github.com/ColorlibHQ/AdminLTE.git -``` - -## Unstable release -### Grab from [jsdelivr](https://www.jsdelivr.com/package/npm/admin-lte) CDN: -_**Important Note**: You needed to add separately cdn links for plugins in your project._ -```html - -``` -```html - -``` -### Using The Command Line: -_**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or higher._ -#### Via npm -```bash -npm install admin-lte@^3.1.0 --save -``` -#### Via Yarn -```bash -yarn add admin-lte@^3.1.0 -``` -#### Via Composer -```bash -composer require "almasaeed2010/adminlte=~3.1.0" -``` -#### Via Git -```bash -git clone https://github.com/ColorlibHQ/AdminLTE.git -``` - -## Documentation - -Visit the [online documentation](https://adminlte.io/docs/3.1/) for the most -updated guide. Information will be added on a weekly basis. - -## Browsers support - -| [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | [iOS Safari](http://godban.github.io/browsers-support-badges/)
iOS Safari | [Samsung](http://godban.github.io/browsers-support-badges/)
Samsung | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | [Vivaldi](http://godban.github.io/browsers-support-badges/)
Vivaldi | [Electron](http://godban.github.io/browsers-support-badges/)
Electron | -| --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | -| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions ### Compile dist files @@ -106,20 +31,19 @@ To compile the dist files you need Node.js/npm, clone/download the repo then: ## Contributing -Please read through our [contributing guidelines](https://github.com/ColorlibHQ/AdminLTE/tree/master/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. - -Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at . +- Highly welcome. +- For your extra reference check [AdminLTE v3 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing) +- First thing first, you should have bit knowledge about NodeJS. +- Github Knowledge. +- Install NodeJS LTS version. +- Clone this Repository to your machine. +- Go to Cloned Folder. +- In cli/bash run `npm install` it will install dependency from `package.json`. +- After installation complets, run `npm run dev` +- Cool, Send urs changes. ## License AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT). AdminLTE.io reserves the right to change the license of future releases. - -## Image Credits - -- [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd) -- [Graphicsfuel](https://www.graphicsfuel.com/2013/02/13-high-resolution-blur-backgrounds/) -- [Pickaface](https://pickaface.net/) -- [Unsplash](https://unsplash.com/) -- [Uifaces](http://uifaces.com/)