diff options
authorPaul Beusterien <paulbeusterien@google.com>2018-07-16 12:47:47 -0700
committerGitHub <noreply@github.com>2018-07-16 12:47:47 -0700
commitd9e7d21f6f0c6cc018963df82663d82cea60e309 (patch)
parentc7fb0a487523b3686a03e3b7f9b459fcb9323a36 (diff)
Add GoogleUtilities README (#1541)
3 files changed, 31 insertions, 2 deletions
diff --git a/GoogleUtilities.podspec b/GoogleUtilities.podspec
index 43833f2..ba1d35b 100644
--- a/GoogleUtilities.podspec
+++ b/GoogleUtilities.podspec
@@ -8,8 +8,7 @@ Internal Google Utilities including Network, Reachability Environment, Logger, a
other Google CocoaPods. They're not intended for direct public usage.
-# TODO update homepage link with GoogleUtilities is moved to another repo.
- s.homepage = 'https://github.com/firebase/firebase-ios-sdk'
+ s.homepage = 'https://github.com/firebase/firebase-ios-sdk/tree/master/GoogleUtilities'
s.license = { :type => 'Apache', :file => 'LICENSE' }
s.authors = 'Google, Inc.'
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
+$ 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.
diff --git a/README.md b/README.md
index 4a5f457..4414b3e 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,10 @@ This repository contains a subset of the Firebase iOS SDK source. It currently
includes FirebaseCore, FirebaseAuth, FirebaseDatabase, FirebaseFirestore,
FirebaseFunctions, FirebaseMessaging and FirebaseStorage.
+The repository also includes GoogleUtilities source. The
+[GoogleUtilities](GoogleUtilities/README.md) pod is
+a set of utilities used by Firebase and other Google products.
Firebase is an app development platform with tools to help you build, grow and
monetize your app. More information about Firebase can be found at