Skip to content

Update README.md #385

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

Jump to bottom
Merged
merged 2 commits into from
Jun 1, 2018
Merged

Update README.md #385

merged 2 commits into from
Jun 1, 2018

Conversation

ajdavid
Copy link
Contributor

@ajdavid ajdavid commented Apr 30, 2018

Spelling and grammar corrections
@ajdavid
Update README.md
518dbd8 
Spelling and grammar corrections
morganchen12
morganchen12 requested changes Apr 30, 2018
View reviewed changes
README.md Outdated
### Quickstart: Uppercaser for [Realtime Database](/quickstarts/uppercase) or [Cloud Firestore](/quickstarts/uppercase-firestore)

This quickstart sample demonstrates using **Cloud Functions** triggered by **Firebase Realtime Database or Cloud Firestore events**. The function uppercase messages written to the datastore.
This quickstart sample demonstrates using **Cloud Functions** triggered by **Firebase Realtime Database or Cloud Firestore events**. The function sets messages that are written to the datastore, to uppercase.
Copy link
Contributor

Choose a reason for hiding this comment

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

This could be better phrased as The function transforms message text written to Firestore to uppercase.
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Hosting triggered HTTPS function quickstart: Big Ben](/quickstarts/big-ben)

This quickstart demonstrates using **Cloud Functions** with an HTTPS trigger that's triggered through a Firebase Hosting URL. The function will display a repeated number of "BONG" depending on the hour of the day.
This quickstart demonstrates using **Cloud Functions** with an HTTPS trigger that's triggered through a Firebase Hosting URL. The function will display a repeated number of "BONG"s, depending on the hour of the day.
Copy link
Contributor

Choose a reason for hiding this comment

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

Comma is optional here
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Auth trigger quickstart: Welcome Email](/quickstarts/email-users)

This quickstart sample demonstrates using **Cloud Functions** triggered by **Firebase Auth events**. The functions sends a Welcome email when user accounts are created (or when users signs-in using an Identity Provider for the first time) and sends a Goodbye email when user accounts are deleted.
This quickstart sample demonstrates using **Cloud Functions** triggered by **Firebase Auth events**. The functions sends a Welcome Email when user accounts are created (or when users sign-in using an Identity Provider for the first time) and sends a Goodbye Email when user accounts are deleted.
Copy link
Contributor

Choose a reason for hiding this comment

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

The functions sends should be either The function sends or The functions send
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md
This sample shows how you can write your Cloud Functions code using the ES2017
syntax. This requires to run a preparation step where your code is transpiled to
syntax. This requires you to run a preparation step where your code is transpiled to
a supported version of JavaScript.
Copy link
Contributor

Choose a reason for hiding this comment

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

Bonus points if you can rephrase this to avoid second-person addresses
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Server-side generated pages w/ Handlebars templating and user sessions](/template-handlebars)

This samples shows how to serve server-side generated HTML pages using the [HandlebarsJs](http://handlebarsjs.com/) templating system and serve User specific content by always passing the Firebase ID token in a `__session` cookie.
This sample shows how to serve server-side generated HTML pages using the [HandlebarsJs](http://handlebarsjs.com/) templating system and serve User specific content by always passing the Firebase ID token in a `__session` cookie.
Copy link
Contributor

Choose a reason for hiding this comment

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

User specific shouldn't be capitalized here, but should be hyphenated.

user-specific
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Limit number of child nodes](/limit-children)

Make sure to keep the number of child nodes below a certain threshold. For instance this can be useful to limit the number of lines of logs or chat history below a given number.
Makes sure that the number of child nodes stays below a certain threshold. For instance this can be useful to limit the number of lines of logs or chat history below a given number.
Copy link
Contributor

Choose a reason for hiding this comment

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

For instance is redundant and can be removed
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Text moderation](/text-moderation)

How to moderate user input text for bad words. For example this can be used to moderate usernames, chat or forum messages.
Demonstrates how to moderate user input text for bad words. For example this can be used to moderate usernames, chat or forum messages.
Copy link
Contributor

Choose a reason for hiding this comment

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

For example is redundant
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [User data cleanup](/user-data-cleanup)

Deletes all associated user data that's on the Realtime database when a user deletes his Firebase account.
Deletes all associated user data that is in the Realtime database when a user deletes his Firebase account.
Copy link
Contributor

Choose a reason for hiding this comment

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

that is in -> in
Copy link
Contributor Author

@ajdavid ajdavid May 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Delete inactive users accounts via cron](/delete-unused-accounts-cron)

Periodically deletes the accounts of users who have not signed in the last month.
Periodically deletes the accounts of users who have not signed-in in the last month.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should remain unhyphenated.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Amended as requested
README.md Outdated
### [Developer Motivator](/developer-motivator)

This sample demonstrates how to send a Firebase Cloud Messaging (FCM) notification to the developer device each time your app get a new user or lose one.
This sample demonstrates how to send a Firebase Cloud Messaging (FCM) notification to the developer device each time your app gets a new user or loses one.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can be rephrased: each time your app gains or loses a user
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Amended as requested
@ajdavid
Update README.md
895b8f5 
Minor revisions to spelling and grammar.
@nicolasgarnier
Copy link
Contributor

Thanks @ajdavid !
@nicolasgarnier nicolasgarnier merged commit f7135ab into firebase:master Jun 1, 2018
@enterstudio enterstudio mentioned this pull request Dec 4, 2022
Open
@KatanMichael KatanMichael mentioned this pull request Dec 4, 2022
Open
@jayserdny jayserdny mentioned this pull request Dec 5, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants

@ajdavid @nicolasgarnier @morganchen12