Skip to content

Commit 27a7cf8

Browse files
author
Curtis Liu
committed
Update README.md
1 parent 7c12d49 commit 27a7cf8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,20 @@ To add properties that are tracked in every event, you can set global properties
5353
globalProperties.key = "value";
5454
amplitude.setGlobalUserProperties(globalProperties);
5555

56+
# Configuration Options #
57+
58+
You can configure Amplitude by passing an object as the third argument to the `init`:
59+
60+
amplitude.init("YOUR_API_KEY_HERE", null, {
61+
// optional configuration options
62+
saveEvents: true
63+
})
64+
65+
| option | description | default |
66+
|------------|----------------------------------------------------------------------------------|-----------|
67+
| saveEvents | If `true`, saves events to localStorage and removes them upon successful upload. | `true` |
68+
69+
5670
# Advanced #
5771

5872
This SDK automatically grabs useful data about the browser, including browser type and operating system version.

0 commit comments

Comments
 (0)