Skip to content

Commit 92bb156

Browse files
authored
Update README.md (#1116)
1 parent e4286d6 commit 92bb156

File tree

1 file changed

+34
-36
lines changed

1 file changed

+34
-36
lines changed

README.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,35 @@
33
The repository contains the Firebase C++ SDK source, with support for Android,
44
iOS, and desktop platforms. It includes the following Firebase libraries:
55

6-
- [AdMob](https://firebase.google.com/docs/admob/)
7-
- [Google Analytics for Firebase](https://firebase.google.com/docs/analytics/)
8-
- [Firebase Authentication](https://firebase.google.com/docs/auth/)
9-
- [Firebase Realtime Database](https://firebase.google.com/docs/database/)
10-
- [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/)
11-
- [Cloud Firestore](https://firebase.google.com/docs/firestore/)
12-
- [Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)
13-
- [Firebase Invites](https://firebase.google.com/docs/invites/)
14-
- [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
15-
- [Firebase Remote Config](https://firebase.google.com/docs/remote-config/)
16-
- [Cloud Storage for Firebase](https://firebase.google.com/docs/storage/)
17-
18-
Firebase is an app development platform with tools to help you build, grow and
19-
monetize your app. More information about Firebase can be found at
20-
<https://firebase.google.com>.
21-
22-
More information about the Firebase C++ SDK can be found at <https://firebase.google.com/docs/cpp/setup>. Samples on how to use the
23-
Firebase C++ SDK can be found at <https://github.com/firebase/quickstart-cpp>.
6+
<img height="200" align="right" src="https://user-images.githubusercontent.com/94545831/196925526-b6f89f3e-0abb-4ea2-842b-371487196463.png" />
7+
8+
|||
9+
|--|--|
10+
|[AdMob](https://firebase.google.com/docs/admob/)|[Google Analytics for Firebase](https://firebase.google.com/docs/analytics/)|
11+
|[Firebase Authentication](https://firebase.google.com/docs/auth/)|[Firebase Realtime Database](https://firebase.google.com/docs/database/)|
12+
|[Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/)|[Cloud Firestore](https://firebase.google.com/docs/firestore/)|
13+
|[Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)|[Firebase Invites](https://firebase.google.com/docs/invites/)|
14+
|[Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)|[Firebase Remote Config](https://firebase.google.com/docs/remote-config/)|
15+
|[Cloud Storage for Firebase](https://firebase.google.com/docs/storage/)|
16+
17+
<br>
18+
19+
Firebase is an app development platform with tools to help you build, grow and monetize your app. More information about Firebase can be found [HERE](https://firebase.google.com).
20+
21+
- More information about the Firebase C++ SDK can be found [HERE](https://firebase.google.com/docs/cpp/setup)
22+
- Samples on how to use the Firebase C++ SDK can be found [HERE](https://github.com/firebase/quickstart-cpp)
23+
24+
<br>
25+
26+
![Github Repo Size](https://img.shields.io/github/repo-size/firebase/firebase-cpp-sdk?style=for-the-badge&color=aqua)
2427

2528
## Table of Contents
2629

2730
1. [Getting Started](#getting-started)
2831
1. [Prerequisites](#prerequisites)
29-
1. [Prerequisites for Desktop](#prerequisites-for-desktop)
30-
1. [Prerequisites for Android](#prerequisites-for-android)
31-
1. [Prerequisites for iOS/tvOS](#prerequisites-for-iostvos)
3232
1. [Building](#building)
33-
1. [Building with CMake](#building-with-cmake)
34-
1. [Building with CMake for iOS](#building-with-cmake-for-ios)
35-
1. [Building with Gradle for Android](#building-with-gradle-for-android)
36-
1. [Proguard File Generation](#proguard-file-generation)
3733
1. [Including in Projects](#including-in-projects)
38-
1. [Including in CMake Projects](#including-in-cmake-projects)
39-
1. [Including in Android Gradle Projects](#including-in-android-gradle-projects)
40-
1. [Contributing](#contributing)
34+
1. [Contributing Guidelines](https://github.com/firebase/firebase-cpp-sdk/blob/main/CONTRIBUTING.md)
4135
1. [License](#license)
4236

4337
## Getting Started
@@ -47,7 +41,8 @@ You can clone the repo with the following command:
4741
git clone https://github.com/firebase/firebase-cpp-sdk.git
4842
```
4943

50-
## Prerequisites
44+
<details><summary><h2>Prerequisites</h2></summary>
45+
5146
The following prerequisites are required for all platforms. Be sure to add any
5247
directories to your PATH as needed.
5348

@@ -103,7 +98,11 @@ necessary version of Gradle for you.
10398
The following prerequisites are required when building the libraries for iOS or tvOS.
10499
- [Cocoapods](https://cocoapods.org/)
105100

106-
## Building
101+
</details>
102+
103+
104+
<details><summary><h2>Building</h2></summary>
105+
107106
### Building with CMake
108107
The build uses CMake to generate the necessary build files, and supports out of
109108
source builds.
@@ -243,6 +242,8 @@ that should be included in your application. The generated file is located in
243242
each library’s build directory. For example, the Analytics proguard file would
244243
be generated to `analytics/build/analytics.pro`.
245244

245+
</details>
246+
246247
## Testing
247248
Each Firebase SDK in this repo includes a series of unit tests. These tests are
248249
built and executed by the CI system in order to validate changes and pull
@@ -267,7 +268,8 @@ respectively. These scripts reside in the base directory of the repository.
267268
**Allow all applications to access this item** radio button.
268269
- Re-run the tests.
269270

270-
## Including in Projects
271+
<details><summary><h2>Including in Projects</h2></summary>
272+
271273
### Including in CMake Projects
272274
Including the Firebase C++ SDK to another CMake project is fairly
273275
straightforward. In the CMakeLists.txt file that wants to include the Firebase
@@ -302,11 +304,7 @@ firebaseCpp.dependencies {
302304
Additional examples of how to do this for each library are available in the
303305
[C++ Quickstarts](https://github.com/firebase/quickstart-cpp).
304306

305-
## Contributing
306-
We love contributions, but note that we are still working on setting up our
307-
test infrastructure, so we may choose not to accept pull requests until we have
308-
a way to validate those changes on GitHub. Please read our
309-
[contribution guidelines](/CONTRIBUTING.md) to get started.
307+
</details>
310308

311309
## License
312310
The contents of this repository is licensed under the

0 commit comments

Comments
 (0)