diff --git a/README.md b/README.md index 5305459df22..54efb4a870a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# [AdminLTE - Bootstrap 5 Admin Dashboard](https://adminlte.io) +# AdminLTE - Bootstrap 5 Admin Dashboard [![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) @@ -6,53 +6,46 @@ [![Discord Invite](https://img.shields.io/badge/discord-join%20now-green)](https://discord.gg/jfdvjwFqfz) [![Netlify Status](https://api.netlify.com/api/v1/badges/1277b36b-08f3-43fa-826a-4b4d24614b3c/deploy-status)](https://app.netlify.com/sites/adminlte-v4/deploys) -**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. +**AdminLTE** is a fully responsive administration template built with **[Bootstrap 5](https://getbootstrap.com/)** framework and essential JavaScript plugins. It offers high customizability and ease of use, catering to various screen resolutions from mobile to desktop. -## Looking for Premium Templates? +## Premium Templates -AdminLTE.io just opened a new premium templates page. Hand picked to ensure the best quality and the most affordable -prices. Visit for more information. +Explore our premium templates for top-notch quality and affordability at [AdminLTE Premium](https://adminlte.io/premium). -!["AdminLTE Presentation"](https://adminlte.io/AdminLTE3.png "AdminLTE Presentation") +![AdminLTE Presentation](https://adminlte.io/AdminLTE3.png) -**AdminLTE** has been carefully coded with clear comments in all of its JS, SCSS and HTML files. -SCSS has been used to increase code customizability. +AdminLTE is meticulously coded with clear comments in JS, SCSS, and HTML files. SCSS enhances code customizability. -## Quick start +## Quick Start -### Compile dist files +### Installation and Compilation -To compile the dist files you need Node.js/npm, clone/download the repo then: - -1. `npm install` (install npm deps) -2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo) -3. `npm run production` (compile css/js files) +To compile the distribution files, ensure you have Node.js/npm installed: +1. Clone/download the repository. +2. Run `npm install` to install dependencies. +3. Optionally, run `npm run dev` for developer mode with auto-compile and Browsersync support. +4. Run `npm run production` to compile CSS/JS files for production. ## Contributing -- Highly welcome. -- For your extra reference check [AdminLTE v4 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 and change to `master` branch. -- Go to Cloned Folder. -- In cli/bash run `npm install` it will install dependency from `package.json`. -- After installation completes, run `npm run dev` -- Cool, Send urs changes in PR to `master` branch. +We welcome contributions! Here's how to get started: + +1. Familiarize yourself with Node.js and GitHub. +2. Clone this repository and switch to the `master` branch. +3. Navigate to the cloned folder and run `npm install` to install dependencies. +4. Run `npm run dev` after installation. +5. Make your changes and submit a pull request to the `master` branch. + +For detailed instructions, refer to the [AdminLTE v4 Contribution Guide](https://github.com/ColorlibHQ/AdminLTE#contributing). ## Sponsorship -Support AdminLTE development by becoming a sponsor. -[Github Sponsors](https://github.com/sponsors/danny007in) or -[PayPal](https://www.paypal.me/daniel007in) +Support AdminLTE development by becoming a sponsor via [GitHub Sponsors](https://github.com/sponsors/danny007in) or [PayPal](https://www.paypal.me/daniel007in). ## 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. +AdminLTE is an open-source project by [AdminLTE.io](https://adminlte.io) licensed under [MIT](https://opensource.org/licenses/MIT). Future releases may change the license. ## Image Credits