Merge pull request #32 from afresh-technologies/update-fork

Update fork

Author: evandcoleman

.scripts/package.sh

@@ -65,7 +65,8 @@ rename_frameworks () {
 zip_frameworks () {
     for i in */*.xcframework; do (
         local name=$(xcframework_name $i)
-        cd "$i/../"; zip -rqo "$name.xcframework.zip" "$name.xcframework"
+        # Preserve symlinks using the -y option
+        cd "$i/../"; zip -ryqo "$name.xcframework.zip" "$name.xcframework"
     ) & done;
     wait
 }

CONTRIBUTING.md

@@ -1,3 +1,26 @@
+# How the Package is generated
+
+The `Package.swift` and `Sources` files are automatically generated via a [script](https://github.com/akaffenberger/firebase-ios-sdk-xcframeworks/blob/master/.scripts/package.sh), which is set to run in a scheduled cron job via Github Actions. 
+
+The script performs the following actions:
+- Downloads the latest release from https://github.com/firebase/firebase-ios-sdk
+- Parses the Firebase.zip to generate Package.swift and Sources/
+- Commits changes on a new branch and creates a PR
+- Creates a draft release, with a tag that mirrors the Firebase release. The draft release includes the assets needed for the swift package
+
+## Running the script locally
+- Install github cli: `$ brew install gh`
+- Generate the swift package: `$ cd .scripts && sh package.sh debug skip-release`
+
+## Testing locally
+There is an iOS Example project that can be used to test that the Package is working as expected.
+- Open the `iOS Example.xcworkspace`
+- Build and run in XCode
+  - Examples currently available for testing:
+    - Firestore
+    - In App Messaging
+    - Google Sign In 
+
 # Contribution Guidelines
 Any and all input is welcome, including:
 

README.md

@@ -42,13 +42,8 @@ Firebase currently supports SPM integration, see the [official SDK integration i
     ```
 
 - Add `-ObjC` to Build Settings -> Other Linker Flags
-- Some Firebase frameworks require resource bundles. To include those, there are two options:
-  
-  Use the provided script to automatically include all Firebase resources. Copy the following into a Run Script Phase:
-  ```
-  sh "${BUILD_DIR%Build/*}SourcePackages/checkouts/firebase-ios-sdk-xcframeworks/.scripts/resources.sh"
-  ```
-  Or, manually drag and drop specific resource bundles into your target's Copy Bundle Resources Phase:
+- Some Firebase frameworks require resource bundles. Drag and drop the ones you need into your target's Copy Bundle Resources Phase:
+
   ![](./assets/draganddrop.gif)
 
 # How it works