Add READMEs to Maven modules (google#2039)

* Add READMEs to Maven modules * Address feedback
riley-kohler · Dec 27, 2021 · abd2191 · abd2191
1 parent 6ffcdf3
commit abd2191
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 7 deletions.
diff --git a/codegen/README.md b/codegen/README.md
@@ -0,0 +1,5 @@
+# gson-codegen
+
+This Maven module contains the source code for automatically generating Gson type adapters.
+
+:warning: This module is currently non-functional and might be removed in the future.
diff --git a/examples/android-proguard-example/README.md b/examples/android-proguard-example/README.md
@@ -0,0 +1,9 @@
+# android-proguard-example
+
+Example Android project showing how to properly configure [ProGuard](https://www.guardsquare.com/proguard).
+ProGuard is a tool for 'shrinking' and obfuscating compiled classes. It can rename methods and fields,
+or remove them if they appear to be unused. This can cause issues for Gson which uses Java reflection to
+access the fields of a class. It is necessary to configure ProGuard to make sure that Gson works correctly.
+
+Also have a look at the [ProGuard manual](https://www.guardsquare.com/manual/configuration/usage#keepoverview)
+for more details on how ProGuard can be configured.
diff --git a/extras/README.md b/extras/README.md
@@ -0,0 +1,6 @@
+# extras
+
+This Maven module contains the source code for supplementary Gson features which
+are not included by default.
+
+The artifacts created by this module are currently not deployed to Maven Central.
diff --git a/gson/README b/gson/README
diff --git a/gson/README.md b/gson/README.md
@@ -0,0 +1,4 @@
+# gson
+
+This Maven module contains the Gson source code. The artifacts created by this module
+are deployed to Maven Central under the coordinates `com.google.code.gson:gson`.
diff --git a/metrics/README.md b/metrics/README.md
@@ -0,0 +1,3 @@
+# metrics
+
+This Maven module contains the source code for running internal benchmark tests against Gson.
diff --git a/proto/README.md b/proto/README.md
@@ -0,0 +1,7 @@
+# proto
+
+This Maven module contains the source code for a JSON serializer and deserializer for
+[Protocol Buffers (protobuf)](https://developers.google.com/protocol-buffers/docs/javatutorial)
+messages.
+
+The artifacts created by this module are currently not deployed to Maven Central.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# metrics

		This Maven module contains the source code for running internal benchmark tests against Gson.