aboutsummaryrefslogtreecommitdiffhomepage
path: root/GoogleUtilities/README.md
diff options
context:
space:
mode:
authorGravatar Paul Beusterien <paulbeusterien@google.com>2018-07-16 12:47:47 -0700
committerGravatar GitHub <noreply@github.com>2018-07-16 12:47:47 -0700
commitd9e7d21f6f0c6cc018963df82663d82cea60e309 (patch)
tree855fdd95f379c8fff46c9fca46b4e5d1c81fa82d /GoogleUtilities/README.md
parentc7fb0a487523b3686a03e3b7f9b459fcb9323a36 (diff)
Add GoogleUtilities README (#1541)
Diffstat (limited to 'GoogleUtilities/README.md')
-rw-r--r--GoogleUtilities/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/GoogleUtilities/README.md b/GoogleUtilities/README.md
new file mode 100644
index 0000000..a154b0f
--- /dev/null
+++ b/GoogleUtilities/README.md
@@ -0,0 +1,26 @@
+# Google Utilities
+
+## Overview
+
+The GoogleUtilities pod is a set of utilities organized into CocoaPods subspecs.
+See the [podspec](../GoogleUtilities.podspec) for a summary of what utilities
+are currently included. They're used by Firebase and other Google products.
+
+Direct usage by non-Google products and CocoaPods is **NOT** currently
+recommended or supported.
+
+## Development
+
+Follow the subsequent instructions to develop, debug, and unit test
+GoogleUtilities:
+
+```
+$ git clone git@github.com:firebase/firebase-ios-sdk.git
+$ cd firebase-ios-sdk/GoogleUtilities/Example
+$ pod update
+$ open GoogleUtilities.xcworkspace
+```
+
+### Running Unit Tests
+
+Choose the one of the Tests* schemes and press Command-u.