Skip to content

Commit 54889b0

Browse files
Update README.md
1 parent d535881 commit 54889b0

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GodotFirebaseAndroid
22

3-
Firebase plugin for Android export in Godot Engine.
3+
**GodotFirebaseAndroid** is an Android plugin for the Godot Engine that integrates Firebase services in Godot Android games and apps.
44

55
## Features
66

@@ -12,9 +12,9 @@ Firebase plugin for Android export in Godot Engine.
1212

1313
---
1414

15-
## Quick Start
15+
## 🚀 Quick Start
1616

17-
**Step 1: Install the Plugin**
17+
### 1. Install the Plugin
1818

1919
- Download the latest release from the [Releases](https://github.com/your-repo/releases) page.
2020

@@ -24,36 +24,32 @@ Firebase plugin for Android export in Godot Engine.
2424
your_project/addons/GodotFirebaseAndroid/
2525
```
2626

27-
- In Godot, go to **Project > Project Settings > Plugins**, and enable **GodotFirebaseAndroid**.
27+
- In Godot, go to:
28+
**Project > Project Settings > Plugins**, and enable **GodotFirebaseAndroid**.
2829

2930
---
3031

31-
**Step 2: Add Firebase to Your Project**
32+
### 2. Add Firebase to Your Project
3233

33-
- Open [Firebase Console](https://console.firebase.google.com)
34+
- Visit [Firebase Console](https://console.firebase.google.com)
3435
- Create a Firebase project and register your Android app.
35-
- Enable the required services (e.g., Authentication, Firestore).
36-
- Download the `google-services.json` file.
37-
- Place it in:
36+
- Enable required services (e.g., Authentication, Firestore).
37+
- Download the `google-services.json` file and place it in:
3838

3939
```
4040
android/build/google-services.json
4141
```
4242

4343
---
4444

45-
**Step 3: Enable Gradle Build for Android Export**
45+
### 3. Enable Gradle Build for Android Export
4646

47-
- In Godot:
48-
**Project > Export > Android > gradle/use_gradle_build**: ✅
47+
In Godot, go to:
4948

50-
---
51-
52-
## Build Notes
49+
**Project > Export > Android > gradle/use\_gradle\_build** and enable it ✅
5350

54-
This plugin automatically modifies `build.gradle` and `settings.gradle` at export time to include the necessary Firebase dependencies.
51+
---
5552

56-
Make sure:
53+
## 📚 Documentation
5754

58-
- Gradle build is enabled before exporting.
59-
- `google-services.json` exists in `android/build/` before export.
55+
Full documentation is available at: https://syntaxerror247.github.io/GodotFirebaseAndroid

0 commit comments

Comments
 (0)