Add README for dist/ folder with usage instructions

- Complete documentation for ready-to-use production build
- CDN usage examples with jsDelivr links
- Deployment instructions for all hosting scenarios
- File inventory and technical specifications
- Quick start guide for immediate usage
pull/5869/head
Aigars Silkalns 2025-06-24 08:17:59 +03:00
parent 215107782c
commit 2f59912a8d
1 changed files with 106 additions and 0 deletions

106
dist/README.md vendored Normal file
View File

@ -0,0 +1,106 @@
# AdminLTE v4.0.0-rc3 - Production Build
This folder contains the **ready-to-use production build** of AdminLTE v4.0.0-rc3.
## ๐Ÿš€ Quick Start
### Option 1: Download & Use Locally
1. Download this entire `dist/` folder
2. Upload to your web server or open `index.html` in a local server
3. All files work immediately - no build process required!
### Option 2: Use as CDN
```html
<!-- CSS -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/ColorlibHQ/AdminLTE@v4.0.0-rc3/dist/css/adminlte.min.css">
<!-- JavaScript -->
<script src="https://cdn.jsdelivr.net/gh/ColorlibHQ/AdminLTE@v4.0.0-rc3/dist/js/adminlte.min.js"></script>
```
## ๐Ÿ“ What's Included
### ๐Ÿ“„ **HTML Pages (37 total)**
- `index.html` - Main dashboard
- `index2.html`, `index3.html` - Alternative dashboards
- `widgets/` - Widget demonstrations
- `layout/` - Layout examples (sidebar variations, RTL, etc.)
- `forms/` - Form examples
- `tables/` - Table examples
- `UI/` - UI component examples
- `examples/` - Login, register, lockscreen pages
- `docs/` - Documentation pages
### ๐ŸŽจ **CSS Files**
- `css/adminlte.css` - Main stylesheet
- `css/adminlte.min.css` - Minified version
- `css/adminlte.rtl.css` - Right-to-left language support
- `css/adminlte.rtl.min.css` - RTL minified
- `css/*.map` - Source maps for debugging
### โšก **JavaScript Files**
- `js/adminlte.js` - Main JavaScript
- `js/adminlte.min.js` - Minified version
- `js/*.map` - Source maps for debugging
### ๐Ÿ–ผ๏ธ **Assets**
- `assets/img/` - All images (logos, avatars, photos, etc.)
- Complete image set for demos and examples
## ๐ŸŒ **Deployment**
### โœ… **Works Everywhere**
- **Static Hosting**: GitHub Pages, Netlify, Vercel, Surge.sh
- **Traditional Hosting**: cPanel, FTP servers, shared hosting
- **CDN**: Use files directly via jsDelivr or GitHub Pages
- **Sub-folders**: Works in any directory structure
### โœ… **Production Ready**
- Optimized CSS and JavaScript (minified versions available)
- All relative paths work regardless of deployment location
- Images load correctly from any hosting scenario
- Zero configuration required
## ๐Ÿ”ง **Technical Details**
### Dependencies (Loaded from CDN)
- **Bootstrap**: 5.3.7
- **Bootstrap Icons**: 1.13.1
- **OverlayScrollbars**: 2.11.0
- **PopperJS**: 2.11.8
### Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
### Features
- **Fully Responsive** - Works on all screen sizes
- **Dark/Light Mode** - Automatic system preference detection
- **RTL Support** - Complete right-to-left language support
- **Accessibility** - WCAG 2.1 AA compliant
- **No Build Required** - Ready to use immediately
## ๐Ÿ†• **What's New in v4.0.0-rc3**
- โœ… **Fixed Production Builds** - Resolved all deployment path issues
- โœ… **Sidebar Navigation** - Fixed badges, arrows, and spacing
- โœ… **Smart Path Resolution** - Works in any deployment scenario
- โœ… **Updated Dependencies** - Latest stable versions of all libraries
- โœ… **Zero Console Errors** - Clean, professional runtime experience
## ๐Ÿ“– **Documentation**
- [Live Demo](https://adminlte.io/themes/v4/)
- [GitHub Repository](https://github.com/ColorlibHQ/AdminLTE)
- [Changelog](https://github.com/ColorlibHQ/AdminLTE/blob/master/CHANGELOG.md)
## ๐Ÿ“„ **License**
MIT License - see [LICENSE](https://github.com/ColorlibHQ/AdminLTE/blob/master/LICENSE) file for details.
---
**AdminLTE** - Free Bootstrap 5 Admin Dashboard Template
Created by [AdminLTE.io](https://adminlte.io) | [ColorlibHQ](https://colorlib.com)