Author: marcprux

README.md

@@ -1,8 +1,205 @@
-# SkipBase
+# SkipFirebase
+
+This package provides Firebase support for Skip app/framework projects.
+The Swift side uses the official Firebase iOS SDK directly,
+with the various `SkipFirebase*` modules passing the transpiled calls
+through to the Firebase Android SDK.
+
+## Modules
+
+### SkipFirebaseAnalytics
+
+Provides limited parity to the [FirebaseAnalytics](https://firebase.google.com/docs/reference/swift/firebaseanalytics/api/reference/Classes/Analytics) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseAppCheck
+
+Provides limited parity to the [FirebaseAppCheck](https://firebase.google.com/docs/reference/swift/firebaseappcheck/api/reference/Classes/AppCheck) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseAuth
+
+Provides limited parity to the [FirebaseAuth](https://firebase.google.com/docs/reference/swift/firebaseauth/api/reference/Classes/Auth) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseCore
+
+Provides limited parity to the [FirebaseCore](https://firebase.google.com/docs/reference/swift/firebasecore/api/reference/Classes/Core) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseCrashlytics
+
+Provides limited parity to the [FirebaseCrashlytics](https://firebase.google.com/docs/reference/swift/firebasecrashlytics/api/reference/Classes/Crashlytics) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseDatabase
+
+Provides limited parity to the [FirebaseDatabase](https://firebase.google.com/docs/reference/swift/firebasedatabase/api/reference/Classes/Database) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseFirestore
+
+Provides limited parity to the [FirebaseFirestore](https://firebase.google.com/docs/reference/swift/firebasefirestore/api/reference/Classes/Firestore) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseFunctions
+
+Provides limited parity to the [FirebaseFunctions](https://firebase.google.com/docs/reference/swift/firebasefunctions/api/reference/Classes/Functions) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseInstallations
+
+Provides limited parity to the [FirebaseInstallations](https://firebase.google.com/docs/reference/swift/firebaseinstallations/api/reference/Classes/Installations) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseMessaging
+
+Provides limited parity to the [FirebaseMessaging](https://firebase.google.com/docs/reference/swift/firebasemessaging/api/reference/Classes/Messaging) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseRemoteConfig
+
+Provides limited parity to the [FirebaseRemoteConfig](https://firebase.google.com/docs/reference/swift/firebaseremoteconfig/api/reference/Classes/RemoteConfig) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
+
+### SkipFirebaseStorage
+
+Provides limited parity to the [FirebaseStorage](https://firebase.google.com/docs/reference/swift/firebasestorage/api/reference/Classes/Storage) API.
+
+Example Package.swift dependency:
+
+```swift
+
+```
+
+Example usage:
+
+```swift
+
+```
 
-This is a free [Skip](https://skip.tools) Swift/Kotlin library project containing the following modules:
 
-SkipBase
 
 ## Building