Skip to content

Commit 0d7f778

Browse files
authored
Add README files (#4857)
* Fix test app and add README's * Undo app changes * Undo app changes * Add description and formatting to README file
1 parent 889d2ac commit 0d7f778

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

firebase-sessions/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Firebase Sessions SDK
2+
3+
The Firebase Sessions SDK is used by Crashlytics and Performance internally to measure sessions.
4+
5+
## Building
6+
7+
All Gradle commands should be run from the root of this repository.
8+
9+
`./gradlew -PprojectsToPublish=":firebase-sessions" publishProjectsToMavenLocal`
10+
11+
## Running Tests
12+
13+
Unit tests:
14+
15+
`./gradlew :firebase-sessions:test`
16+
17+
Integration tests, requiring a running and connected device (emulator or real):
18+
19+
`./gradlew :firebase-sessions:connectedAndroidTest`
20+
21+
## Code Formatting
22+
23+
Format Kotlin code in this SDK in Android Studio using
24+
the [ktfmt plugin](https://plugins.jetbrains.com/plugin/14912-ktfmt) with code style to
25+
**Google (internal)**, or by running:
26+
27+
`./gradlew :firebase-sessions:ktfmtFormat`

firebase-sessions/test-app/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Firebase Sessions Test App
2+
3+
## Setup
4+
5+
Download the `google-services.json` file
6+
from [Firebase Console](https://console.firebase.google.com/) (for whatever Firebase project you
7+
have or want to integrate the `test-app`) and store it under the current directory.
8+
9+
Note: The [Package name](https://firebase.google.com/docs/android/setup#register-app) for your app
10+
created on the Firebase Console (for which the `google-services.json` is downloaded) must match
11+
the [applicationId](https://developer.android.com/studio/build/application-id.html) declared in
12+
the `test-app/test-app.gradle.kts` for the app to link to Firebase.
13+
14+
## Running
15+
16+
Run the test app directly from Android Studio by selecting and running
17+
the `firebase-sessions.test-app` run configuration.

0 commit comments

Comments
 (0)