diff --git a/README.md b/README.md new file mode 100644 index 0000000..7fb36d2 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# PeDitX Theme for OpenWrt + +![PeDitX Banner](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/luasrc/brand.png) + +## Language Selection: + +[**English**](README.md) | [**فارسی**](README_fa.md) | [**中文**](README_zh.md) | [**Русский**](README_ru.md) + +PeDitX is a theme designed for OpenWrt, specifically optimized for mobile devices. It is the first theme from PeDitX for OpenWrt and is highly optimized and visually appealing. It also supports **PWA** (Progressive Web App) functionality, making it compatible with modern web standards, and is easily usable across all OpenWrt versions. + +## Features: + +- Optimized for mobile +- Supports **PWA** (Progressive Web App) +- Custom and beautiful design +- Usable across all OpenWrt versions +- Built upon the Bootstrap theme + +## Download Links: +[![Download PeDitX Theme](https://img.shields.io/github/downloads/peditx/luci-theme-peditx/total.svg)](https://github.com/peditx/luci-theme-peditx/releases) + +## License: +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +This theme is released under the **Apache License 2.0**. You are free to use and distribute it as per the terms of the license. + +## Contact Us: +[![Telegram](https://img.shields.io/badge/Telegram-Join%20Now-blue.svg)](https://t.me/peditx) + +## Warning: +This theme has not been tested on the **LEDE** version. + +## Preview Images: + +### Computer Screenshots: +![Screenshot 1](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/1.png) +![Screenshot 2](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/2.png) +![Screenshot 3](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/3.png) +![Screenshot 4](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/4.png) + +### Mobile Screenshots: +![Mobile Screenshot 1](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/m1.PNG) +![Mobile Screenshot 2](https://raw.githubusercontent.com/peditx/luci-theme-peditx/refs/heads/main/screenshots/m2.PNG) + +## Special Thanks: + +- [PeDitX](https://github.com/peditx) +- [PeDitXRT](https://github.com/peditxrt) +- [OpenWrt](https://github.com/openwrt) +- [ImmortalWrt](https://github.com/immortalwrt) +- [Bootstrap Theme](https://github.com/twbs/bootstrap) + +This theme is based on the [Bootstrap Theme](https://github.com/twbs/bootstrap).