Skip to content

Fix typos and add relevant links in README.md #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
riggaroo merged 2 commits into from
Jun 9, 2025
Merged

Fix typos and add relevant links in README.md #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b16395b
Fix typos and add relevant links in README.md
SimonMarquis May 31, 2025
cdd482f
Update README.md
SimonMarquis May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ The app combines a variety of different Google technologies, such as:
1. Clone the repository.
2. Create a [Firebase project](https://firebase.google.com/products/firebase-ai-logic) and
generate a `google-services.json` file.
Replace the current placeholder app/google-services.json file with your own json file created
above. Be sure to enable Vertex AI SDK.
Ensure to also enable AppCheck on your Firebase project to prevent API abuse.
Replace the current placeholder [`app/google-services.json`](app/google-services.json) file with your own JSON file created
above. Be sure to enable [Vertex AI API](https://console.cloud.google.com/apis/library/aiplatform.googleapis.com).
Ensure to also enable [AppCheck](https://console.firebase.google.com/project/_/appcheck) on your Firebase project to prevent API abuse.
Copy link
Collaborator

@riggaroo riggaroo Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't link correctly to AppCheck

Copy link
Contributor Author

@SimonMarquis SimonMarquis Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should link to the AppCheck page of the Firebase console but it will first ask you to select a project. Would you prefer a "public" documentation page?

Copy link
Contributor Author

@SimonMarquis SimonMarquis Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm the link works as intended. It opens the Firebase console and asks to choose a project to continue.
Let me know if you prefer this link that will work even for users that don't have a firebase account.
https://firebase.google.com/docs/app-check

Copy link
Contributor Author

@SimonMarquis SimonMarquis Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main benefit of using this link is to be able to directly enable the feature from the console.


3. This project makes use of remote config on Firebase too, you can import the [Firebase Remote config](https://firebase.google.com/docs/remote-config) settings from
[`remote_config_defaults.xml`](core/network/src/main/res/xml/remote_config_defaults.xml)

4. If you'd like to change the font that the app renders with, an optional spec can be placed in
`~/gradlew/gradle.properties` file:
`~/.gradle/gradle.properties` file:

```
fontName="Roboto Flex"
Expand Down