更新 README.md

README.md

@@ -1,3 +1,40 @@
-# ner
+# XXB No Email Register
 
-Remove email field from registration form and skip email verification.
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://git.parlz.com/Xiaoxiaobai5724/ner/blob/2.x/LICENSE) [![Latest Stable Version](https://img.shields.io/packagist/v/xxb5724/ner.svg)](https://packagist.org/packages/xxb5724/ner) [![Total Downloads](https://img.shields.io/packagist/dt/xxb5724/ner.svg)](https://packagist.org/packages/xxb5724/ner)
+
+> #### Note
+This extension is not recommended unless you have special requirements, as it will break Flarum's email notification system.
+
+A Flarum 2.0 extension. It removes the email input field from the registration form and skips email verification, allowing users to register without providing an email.
+
+### Features
+
+- **Hide Email Input**: The email field no longer appears in the registration popup.
+- **No Email Verification**: New users are activated immediately without needing to verify their email.
+- **Automatic Fake Email**: Automatically generates a unique fake email for users to avoid database unique index conflicts.
+
+### Installation
+
+Install via Composer:
+
+```bash
+composer require xxb5724/ner
+php flarum cache:clear
+```
+
+### Update
+
+```bash
+composer update xxb5724/ner
+php flarum cache:clear
+```
+
+### Uninstall
+
+```bash
+composer remove xxb5724/ner
+php flarum cache:clear
+```
+
+### Contribution
+- Tsiem Tsheng