From abd2191b0e3863aa227b19fd3ebc6820cbcec058 Mon Sep 17 00:00:00 2001
From: Marcono1234 <Marcono1234@users.noreply.github.com>
Date: Mon, 27 Dec 2021 19:17:41 +0100
Subject: [PATCH] Add READMEs to Maven modules (#2039)

* Add READMEs to Maven modules

* Address feedback
---
 codegen/README.md                           | 5 +++++
 examples/android-proguard-example/README.md | 9 +++++++++
 extras/README.md                            | 6 ++++++
 gson/README                                 | 7 -------
 gson/README.md                              | 4 ++++
 metrics/README.md                           | 3 +++
 proto/README.md                             | 7 +++++++
 7 files changed, 34 insertions(+), 7 deletions(-)
 create mode 100644 codegen/README.md
 create mode 100644 examples/android-proguard-example/README.md
 create mode 100644 extras/README.md
 delete mode 100644 gson/README
 create mode 100644 gson/README.md
 create mode 100644 metrics/README.md
 create mode 100644 proto/README.md

diff --git a/codegen/README.md b/codegen/README.md
new file mode 100644
index 00000000..adee425a
--- /dev/null
+++ 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
new file mode 100644
index 00000000..bc4b2e75
--- /dev/null
+++ 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
new file mode 100644
index 00000000..41447726
--- /dev/null
+++ 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
deleted file mode 100644
index a925a5cd..00000000
--- a/gson/README
+++ /dev/null
@@ -1,7 +0,0 @@
-Gson is a Java library that can be used to convert Java Objects into their 
-JSON representation. It can also be used to convert a JSON string to an 
-equivalent Java object. Gson can work with arbitrary Java objects including 
-pre-existing objects that you do not have source-code of.
-
-Complete Gson documentation is available at its project page 
-https://github.com/google/gson
diff --git a/gson/README.md b/gson/README.md
new file mode 100644
index 00000000..75ec9fc9
--- /dev/null
+++ 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
new file mode 100644
index 00000000..8c95485d
--- /dev/null
+++ 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
new file mode 100644
index 00000000..c6f7906a
--- /dev/null
+++ 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.