Need ProGuard rules in docs - app crashes in release mode but works fine in debug

[PRATHAMESHG1234]

Have you checked for an existing issue?

• I have searched the existing issues

Use case

The Problem I Hit

I just spent way too much time debugging why my app works perfectly in debug but crashes immediately in release mode. Turns out Flutter Quill needs specific ProGuard rules that aren't mentioned anywhere in the docs.

Here's what happened:

• Added Flutter Quill to my app
• Everything worked great in development
• Built release APK for testing
• App crashes on startup with this cryptic error:

java.lang.NullPointerException:

Attempt to invoke virtual method 'void androidx.lifecycle.E.g(java.lang.String, w5.d)' on a null object reference

Spent hours thinking it was my code, Firebase, or some other package. The error message is completely unhelpful because of minification - androidx.lifecycle.E.g() tells me nothing.

What's Actually Happening

When you build for release, Android's R8 minifier renames classes and methods. Flutter Quill uses lifecycle components internally, and when those get renamed, the app can't find them anymore and crashes.

This only happens in release builds because debug builds don't minify code.

Why This Sucks for Developers

1. Works fine during development, fails in production - classic gotcha
2. Error messages are garbage because of obfuscation
3. No obvious connection to Flutter Quill in the crash logs
4. Zero documentation about this anywhere

I eventually figured out I needed to add ProGuard rules, but it took way longer than it should have.

Proposal

Just Add This to the README

Can we please add a simple section about Android release builds? Something like:

---

📱 Android Release Builds

If your app crashes on startup in release mode (but works in debug), you need to add these lines to android/app/proguard-rules.pro:

# Flutter Quill lifecycle fix
-keep class androidx.lifecycle.** { *; }
-keep class * extends androidx.lifecycle.LifecycleObserver { *; }