Skip to content

Commit e65fb1f

Browse files
jhuleattlaurenzlong
authored andcommitted
docs(firestore-counter): change "Counter SDK" to "Client Sample" (#177)
1 parent c7a1bc3 commit e65fb1f

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

firestore-counter/POSTINSTALL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ gcloud --project=${param:PROJECT_ID} scheduler jobs create pubsub ${param:EXT_IN
3535
```
3636

3737

38-
#### Specify a document path and increment value in your app
38+
#### Specify a document path and increment value in your web app
3939

40-
1. Download and copy the [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/dist/sharded-counter.js) into your application project.
40+
1. Download and copy the [compiled client sample](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/dist/sharded-counter.js) into your application project.
4141

42-
1. Use the Counter SDK library in your code to increment counters. The code snippet below shows an example of how to use the library. For more comprehensive API documentation, refer to the [source code](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts).
42+
1. Use the client sample in your code to increment counters. The code snippet below shows an example of how to use it. To see the full reference implementation, refer to the sample's TypeScript [source code](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts).
4343

4444
```html
4545
<html>
@@ -81,7 +81,7 @@ After you complete the post-installation configuration above, the process runs a
8181

8282
1. Your extension creates subcollections in all the documents that your app uses as counters.
8383

84-
1. The client SDK writes to these subcollections to distribute the write load.
84+
1. The client sample writes to these subcollections to distribute the write load.
8585

8686
1. The controllerCore function sums the subcollections' values into the single `visits` field (or whichever field you configured in your master document).
8787

firestore-counter/PREINSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here are some features of this extension:
88
- Supports an arbitrary number of counters in your app.
99
- Works offline and provides latency compensation for the main counter.
1010

11-
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.
11+
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.
1212

1313

1414
#### Additional setup
@@ -19,7 +19,7 @@ After installing this extension, you'll need to:
1919

2020
- Update your [database security rules](https://firebase.google.com/docs/rules).
2121
- 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.
22-
- 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.
22+
- 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.
2323

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

0 commit comments

Comments
 (0)