Skip to content

Commit 5bf04c5

Browse files
author
Lauren Long
committed
chore(*): Regenerate readmes
1 parent 9bcf98e commit 5bf04c5

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

firestore-counter/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Since Cloud Firestore has a limit of one sustained write per second, per documen
1010

1111
Here are some features of this extension:
1212

13-
- Scales from 0 updates per second to at least 10,000 per second.
13+
- Scales from 0 updates per second to a maximum of 10,000 per second.
1414
- Supports an arbitrary number of counters in your app.
1515
- Works offline and provides latency compensation for the main counter.
1616

17-
Note that this extension is currently fully resourced for use with JavaScript apps (we provide the required [JS SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts)). You can, however, use this extension on other platforms if you'd like to develop your own API based on the provided JS SDK.
17+
Note that this extension requires client-side logic to work. We provide a [TypeScript client sample implementation](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) and its [compiled minified JavaScript](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/dist/sharded-counter.js). You can use this extension on other platforms if you'd like to develop your own client code based on the provided client sample.
1818

1919

2020
#### Additional setup
@@ -25,7 +25,7 @@ After installing this extension, you'll need to:
2525

2626
- Update your [database security rules](https://firebase.google.com/docs/rules).
2727
- Set up a [Cloud Scheduler job](https://cloud.google.com/scheduler/docs/quickstart) to regularly call the controllerCore function, which is created by this extension. It works by either aggregating shards itself or scheduling and monitoring workers to aggregate shards.
28-
- Install the provided [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
28+
- Use the provided [client sample](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) or your own client code to specify your document path and increment values.
2929

3030
Detailed information for these post-installation tasks are provided after you install this extension.
3131

firestore-send-email/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ admin.firestore().collection('mail').add({
2222

2323
You can also optionally configure this extension to render emails using [Handlebar](https://handlebarsjs.com/) templates. Each template is a document stored in a Cloud Firestore collection.
2424

25-
When you configure this extension, you'll need to supply your **SMTP credentials for mail delivery**.
25+
When you configure this extension, you'll need to supply your **SMTP credentials for mail delivery**. Note that this extension is for use with bulk email service providers, like SendGrid, Mailgun, etc.
2626

2727
#### Additional setup
2828

0 commit comments

Comments
 (0)