Skip to content

Commit e32d533

Browse files
committed
Rewrite README to be more human and concise
1 parent 5d4803d commit e32d533

File tree

1 file changed

+62
-110
lines changed

1 file changed

+62
-110
lines changed

README.md

Lines changed: 62 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,141 +1,93 @@
1-
# UIBloatwareRegistry
1+
# Android Bloatware Remover
22

3-
A comprehensive Android bloatware removal tool that helps you identify and safely remove pre-installed applications that affect device performance and privacy without root.
3+
Remove unwanted pre-installed apps from your Android phone without root access. Works with Samsung, Xiaomi, Oppo, Vivo, Realme, Tecno, and OnePlus devices.
44

5-
## Features
5+
## What it does
66

7-
- **Automatic Device Detection**: Detects your device brand and loads appropriate removal scripts
8-
- **Interactive Mode**: Choose exactly which apps to remove with safety warnings
9-
- **All Apps Listing**: View and select from all installed applications on your device
10-
- **Risk Assessment**: Each package is categorized as safe, caution, or dangerous
11-
- **App Name Resolution**: Shows human-readable app names alongside package names
12-
- **Backup System**: Create backups before removal for easy restoration
13-
- **Logging**: Detailed logs of all operations for troubleshooting
14-
- **Professional Interface**: Clean, user-friendly command-line interface
7+
Your phone comes with tons of apps you never asked for. This tool helps you get rid of them safely using ADB (Android Debug Bridge). No root required.
158

16-
## Supported Brands
9+
## Supported phones
1710

18-
Currently supported:
19-
- **Samsung** - Galaxy series devices with One UI
20-
- **Xiaomi** - Mi, Redmi, and POCO devices with MIUI
21-
- **Oppo** - Oppo devices with ColorOS
22-
- **Vivo** - Vivo and iQOO devices with FunTouch OS
23-
- **Realme** - Realme devices with Realme UI
24-
- **Tecno** - Tecno devices with HiOS
25-
- **OnePlus** - OnePlus devices with OxygenOS
11+
- Samsung (One UI)
12+
- Xiaomi, Redmi, POCO (MIUI)
13+
- Oppo (ColorOS)
14+
- Vivo, iQOO (FunTouch OS)
15+
- Realme (Realme UI)
16+
- Tecno (HiOS)
17+
- OnePlus (OxygenOS)
2618

27-
Coming soon:
28-
- Huawei (EMUI/HarmonyOS)
29-
- Honor (Magic UI)
30-
- Motorola (My UX)
31-
- Nothing (Nothing OS)
19+
## Setup
3220

33-
## Prerequisites
21+
1. **Install ADB**
22+
- Windows: Download Android SDK Platform Tools, add to PATH
23+
- Mac: `brew install android-platform-tools`
24+
- Linux: `sudo apt install android-tools-adb`
3425

35-
- **Python 3.6+** installed on your computer
36-
- **ADB (Android Debug Bridge)** installed and added to PATH
37-
- **USB cable** to connect your device
38-
- **Android device** with USB debugging enabled
26+
2. **Enable USB Debugging on your phone**
27+
- Settings → About Phone → Tap "Build Number" 7 times
28+
- Settings → Developer Options → Enable "USB Debugging"
3929

40-
### Installing ADB
30+
3. **Get the tool**
31+
```bash
32+
git clone https://github.com/AnantMishra01/UIBloatwareRegistry.git
33+
cd UIBloatwareRegistry
34+
```
4135

42-
**Windows:**
43-
1. Download Android SDK Platform Tools
44-
2. Extract and add to PATH environment variable
36+
## How to use
4537

46-
**macOS:**
38+
Connect your phone and run:
4739
```bash
48-
brew install android-platform-tools
40+
python main.py
4941
```
5042

51-
**Linux:**
52-
```bash
53-
sudo apt install android-tools-adb # Ubuntu/Debian
54-
sudo pacman -S android-tools # Arch Linux
55-
```
43+
You'll get three options:
5644

57-
### Enable USB Debugging
45+
1. **Interactive mode** - Shows known bloatware, you pick what to remove
46+
2. **All apps mode** - Lists every app on your phone, you choose what goes
47+
3. **Batch mode** - Removes all known bloatware at once (be careful!)
5848

59-
1. Go to Settings > About Phone
60-
2. Tap "Build Number" 7 times to enable Developer Options
61-
3. Go to Settings > Developer Options
62-
4. Enable "USB Debugging"
49+
## Safety features
6350

64-
## Quick Start
51+
- **Risk levels**: Apps marked as SAFE, CAUTION, or DANGEROUS
52+
- **Backups**: Creates restore points before removing anything
53+
- **Test mode**: Try it without a phone using `python main.py --test`
54+
- **App names**: Shows "Facebook" instead of cryptic package names
6555

66-
1. **Clone the repository:**
67-
```bash
68-
git clone https://github.com/AnantMishra01/UIBloatwareRegistry.git
69-
cd UIBloatwareRegistry
70-
```
56+
## Example
7157

72-
2. **Connect your device and run:**
73-
```bash
74-
python main.py
7558
```
76-
77-
3. **Or test without a device:**
78-
```bash
79-
python main.py --test
59+
Found 45 applications
60+
==================================================
61+
1. [SAFE] Facebook
62+
Package: com.facebook.katana
63+
64+
2. [CAUTION] Gmail
65+
Package: com.google.android.gm
66+
67+
3. [DANGEROUS] Phone
68+
Package: com.android.dialer
69+
70+
Enter your selection: 1,5-8,12
71+
Selected 6 apps for removal
72+
Create backup? (y/n): y
73+
Proceed? (yes): yes
8074
```
8175

82-
The tool will automatically detect your device brand and guide you through the removal process.
76+
## Important stuff
8377

84-
## Usage Modes
85-
86-
### Interactive Mode (Recommended)
87-
- Review each package before removal
88-
- See risk levels and descriptions
89-
- Create backups automatically
90-
- Perfect for beginners
91-
92-
### All Apps Mode (Advanced)
93-
- Lists all installed applications on device
94-
- Shows app names and package names
95-
- Select any app for removal
96-
- Includes risk assessment for known bloatware
97-
- Full control over what gets removed
98-
99-
### Batch Mode (Expert)
100-
- Remove all configured packages at once
101-
- Faster for experienced users
102-
- Use with extreme caution
103-
104-
### Test Mode
105-
- Run without ADB or connected device
106-
- Perfect for testing and development
107-
- No actual changes are made
108-
- Use `--test` or `-t` flag
109-
110-
## Safety Information
111-
112-
**Risk Levels:**
113-
- **SAFE**: Can be removed without issues
114-
- **CAUTION**: May affect some functionality
115-
- **DANGEROUS**: Could cause system instability
116-
117-
**Important Notes:**
118-
- Always create backups before removal
119-
- Test on a non-primary device first
120-
- Use test mode to preview changes without risk
121-
- Some apps may reinstall after system updates
122-
- Factory reset will restore all removed apps
78+
- **Always backup first** - Things can go wrong
79+
- **Test on an old phone** - Don't experiment on your daily driver
80+
- **Some apps come back** - System updates might restore them
81+
- **Factory reset fixes everything** - If you mess up, this will restore all apps
12382

12483
## Contributing
12584

126-
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
127-
128-
**Ways to contribute:**
129-
- Add support for new device brands
130-
- Update package lists with new bloatware
131-
- Improve safety classifications
132-
- Report bugs and issues
133-
- Enhance documentation
85+
Found a bug? Want to add support for your phone brand? Check out [CONTRIBUTING.md](CONTRIBUTING.md).
13486

135-
## Disclaimer
87+
## Warning
13688

137-
Removing system applications may affect device functionality. Use this tool at your own risk. Always create backups and understand what each package does before removal. The developers are not responsible for any damage to your device.
89+
This tool modifies your phone's software. We're not responsible if something breaks. Use common sense and make backups.
13890

13991
## License
14092

141-
This project is licensed under the [MIT License](LICENSE).
93+
MIT License - do whatever you want with this code.

0 commit comments

Comments
 (0)