Skip to content

Commit 3322029

Browse files
mgksmgks
authored
Update README.md
1 parent 890a575 commit 3322029

File tree

1 file changed

+72
-44
lines changed

1 file changed

+72
-44
lines changed

‎README.md‎

Lines changed: 72 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,46 @@
1111
MIT License — https://opensource.org/licenses/MIT
1212
-->
1313

14-
# Android Smart WebView
15-
16-
<a href="https://github.com/mgks/Android-SmartWebView/">
17-
<img align="right" src="https://raw.githubusercontent.com/mgks/Android-SmartWebView/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp" width="175" alt="Smart WebView Logo">
18-
</a>
19-
20-
<p>
21-
<a href="#features"><img alt="Language" src="https://img.shields.io/badge/language-Java-red.svg"></a>
22-
<a href="https://github.com/mgks/Android-SmartWebView/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/mgks/android-smartwebview"></a>
23-
<a href="https://github.com/mgks/Android-SmartWebView/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/mgks/android-smartwebview"></a>
24-
</p>
25-
26-
**Android Smart WebView** is a modern, open-source solution for building advanced hybrid Android apps. It provides a robust foundation for converting any website into a feature-rich mobile application, complete with a powerful plugin system for extending native functionality.
27-
28-
**[DOCUMENTATION](http://mgks.github.io/Android-SmartWebView/documentation/)** | **[DISCUSSIONS](https://github.com/mgks/Android-SmartWebView/discussions)** | **[ISSUES](https://github.com/mgks/Android-SmartWebView/issues)**
29-
30-
## Core Features
14+
<div align="center">
15+
16+
<!-- PROJECT TITLE -->
17+
<img src="https://raw.githubusercontent.com/mgks/Android-SmartWebView/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.webp" width="150" alt="Smart WebView Logo">
18+
19+
<h1>Android Smart WebView</h1>
20+
21+
<!-- ONE LINE SUMMARY -->
22+
<p>
23+
<b>A clean and modern, open-source solution for building advanced hybrid android apps.</b>
24+
</p>
25+
26+
<!-- BADGES -->
27+
<p>
28+
<img alt="Language" src="https://img.shields.io/badge/language-Java-red.svg?style=flat-square">
29+
<img src="https://img.shields.io/github/v/release/mgks/android-smartwebview?style=flat-square&color=38bd24" alt="release version">
30+
<!--<img src="https://img.shields.io/github/stars/mgks/android-smartwebview?style=flat-square&logo=github&color=blue" alt="stars">
31+
<img src="https://img.shields.io/github/forks/mgks/android-smartwebview?style=flat-square&color=blue" alt="stars">-->
32+
<img src="https://img.shields.io/github/license/mgks/android-smartwebview.svg?style=flat-square&color=blue" alt="license">
33+
</p>
34+
35+
<!-- MENU -->
36+
<p>
37+
<h4>
38+
<a href="http://mgks.github.io/Android-SmartWebView/documentation/">Documentation</a> •
39+
<a href="https://github.com/mgks/Android-SmartWebView/discussions">Discussions</a> •
40+
<a href="https://github.com/mgks/Android-SmartWebView/issues">Issues</a>
41+
</h4>
42+
</p>
43+
44+
<!-- PREVIEW -->
45+
<p>
46+
<img width="850" alt="cover-swv" src="https://github.com/user-attachments/assets/615e82f1-18fe-42a7-bf98-0a4c53660995" />
47+
</p>
48+
49+
</div>
50+
51+
**Android Smart WebView** provides a robust foundation for converting any website into a feature-rich mobile application, complete with a powerful plugin system for extending native functionality.
52+
53+
## Features
3154

3255
* **Plugin Architecture:** Extend app functionality with self-registering, modular plugins.
3356
* **File Uploads & Camera Access:** Full support for `<input type="file">`, including direct camera capture.
@@ -39,32 +62,6 @@
3962
* **Downloads & Printing:** Handle file downloads and print web content using native services.
4063
* **Modern & Secure:** Built with up-to-date libraries, security best practices, and highly configurable via `swv.properties`.
4164

42-
## Included Plugins
43-
44-
Smart WebView now includes all plugins for free, providing a comprehensive toolkit to build powerful hybrid apps out of the box.
45-
46-
* ✅ **AdMob:** Integrate Google AdMob banner, interstitial, and rewarded ads.
47-
* ✅ **Biometric Authentication:** Secure your app with fingerprint or face unlock.
48-
* ✅ **QR & Barcode Reader:** Natively scan QR codes and barcodes using the device camera.
49-
* ✅ **Image Compression:** Automatically compress images before uploading to save bandwidth and improve performance.
50-
* ✅ **JS Interface:** A powerful two-way bridge for seamless communication between your web app's JavaScript and native Android code.
51-
* ✅ **Location:** On-demand access to the device's GPS location.
52-
* ✅ **Native Dialogs:** Display native alert and confirmation dialogs from your JavaScript.
53-
* ✅ **Toast Messages:** Show short, non-blocking native toast notifications.
54-
* ✅ **In-App Review:** Prompt users to rate your app on the Google Play Store based on usage triggers.
55-
56-
## Standalone Libraries 📦
57-
58-
We are modularizing the best parts of Smart WebView into lightweight, standalone libraries that you can use in **any** Android project (Native or Hybrid).
59-
60-
| Library | Description |
61-
| :--- | :--- |
62-
| **[Biometric Gate](https://github.com/mgks/android-biometric-gate)** | 🛡️ Secure, lifecycle-aware lock screen for any Activity. |
63-
| **[File Handler](https://github.com/mgks/android-webview-file-handler)** | 📂 Painless file uploads & camera captures for WebViews. |
64-
| **[JS Bridge](https://github.com/mgks/android-webview-js-bridge)** | 🌉 Two-way, Promise-based communication between Kotlin & JS. |
65-
| **[Print Helper](https://github.com/mgks/android-webview-print-helper)** | 🖨️ One-line printing for Android WebViews. |
66-
| **[FCM Sync](https://github.com/mgks/android-webview-fcm-sync)** | ☁️ Sync Firebase Push Tokens to WebView Cookies. |
67-
6865
## Quick Start
6966

7067
1. **Clone the repository:**
@@ -95,6 +92,32 @@ All primary configuration is done within `app/src/main/assets/swv.properties`:
9592
* **Plugin Configuration:**
9693
* Plugin-specific behavior (like AdMob IDs or Biometric Auth on launch) is configured in `Playground.java`. This allows you to change settings without modifying the plugin source code itself.
9794

95+
## Included Plugins
96+
97+
Smart WebView now includes all plugins for free, providing a comprehensive toolkit to build powerful hybrid apps out of the box.
98+
99+
* **AdMob:** Integrate Google AdMob banner, interstitial, and rewarded ads.
100+
* **Biometric Authentication:** Secure your app with fingerprint or face unlock.
101+
* **QR & Barcode Reader:** Natively scan QR codes and barcodes using the device camera.
102+
* **Image Compression:** Automatically compress images before uploading to save bandwidth and improve performance.
103+
* **JS Interface:** A powerful two-way bridge for seamless communication between your web app's JavaScript and native Android code.
104+
* **Location:** On-demand access to the device's GPS location.
105+
* **Native Dialogs:** Display native alert and confirmation dialogs from your JavaScript.
106+
* **Toast Messages:** Show short, non-blocking native toast notifications.
107+
* **In-App Review:** Prompt users to rate your app on the Google Play Store based on usage triggers.
108+
109+
## Standalone Libraries
110+
111+
We are modularizing the best parts of Smart WebView into lightweight, standalone libraries that you can use in **any** Android project (Native or Hybrid).
112+
113+
| Library | Description |
114+
| :--- | :--- |
115+
| **[Biometric Gate](https://github.com/mgks/android-biometric-gate)** | Secure, lifecycle-aware lock screen for any Activity. |
116+
| **[File Handler](https://github.com/mgks/android-webview-file-handler)** | Painless file uploads & camera captures for WebViews. |
117+
| **[JS Bridge](https://github.com/mgks/android-webview-js-bridge)** | Two-way, Promise-based communication between Kotlin & JS. |
118+
| **[Print Helper](https://github.com/mgks/android-webview-print-helper)** | One-line printing for Android WebViews. |
119+
| **[FCM Sync](https://github.com/mgks/android-webview-fcm-sync)** | Sync Firebase Push Tokens to WebView Cookies. |
120+
98121
## Further Information
99122

100123
The best way to understand the project in depth is to explore the source code:
@@ -111,4 +134,9 @@ The best way to understand the project in depth is to explore the source code:
111134
* Have questions or want to share what you've built? [Join the discussion](https://github.com/mgks/Android-SmartWebView/discussions).
112135
113136
## License
114-
This project is licensed under the [MIT License](LICENSE).
137+
138+
Distributed under the MIT License. See `LICENSE` for more information.
139+
140+
> **{ github.com/mgks }**
141+
>
142+
> ![Website Badge](https://img.shields.io/badge/Visit-mgks.dev-blue?style=flat&link=https%3A%2F%2Fmgks.dev) ![Sponsor Badge](https://img.shields.io/badge/%20%20Become%20a%20Sponsor%20%20-red?style=flat&logo=github&link=https%3A%2F%2Fgithub.com%2Fsponsors%2Fmgks)

0 commit comments

Comments
 (0)