Add note on Android Proguard settings in README.

ktuukkan · Dec 14, 2021 · 41f8da2 · 41f8da2
1 parent 3ba88f5
commit 41f8da2
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,17 @@ SentenceFactory sf = SentenceFactory.getInstance();
 GSASentence gsa = (GSASentence) sf.createParser(nmea);
 ```
 
+Recommended Android Proguard settings when `minifyEnabled` is set `true`:
+
+```
+-keep class net.sf.marineapi.** { *; }
+-keep interface net.sf.marineapi.** { *; }
+-keepattributes MethodParameters
+-dontwarn gnu.io.CommPortIdentifier
+-dontwarn gnu.io.RXTXPort
+-dontwarn gnu.io.SerialPort
+```
+
 See also:
 - [Examples](src/main/java/net/sf/marineapi/example)
 - [Javadocs](http://www.javadoc.io/doc/net.sf.marineapi/marineapi)