Skip to content

Commit 761d9ec

Browse files
authored
fix: update items and doc link in readme (#38)
1 parent 58b4265 commit 761d9ec

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Clickstream Web SDK can help you easily collect and report events from browser t
66

77
The SDK relies on the Amplify for JS SDK Core Library and is developed according to the Amplify AnalyticsProvider interface. In addition, we've added features that automatically collect common user events and attributes (e.g., page view, first open) to simplify data collection for users.
88

9-
Visit our [Documentation site](https://awslabs.github.io/clickstream-analytics-on-aws/en/sdk-manual/web/) to learn more about Clickstream Web SDK.
9+
Visit our [Documentation site](https://awslabs.github.io/clickstream-analytics-on-aws/en/latest/sdk-manual/web/) to learn more about Clickstream Web SDK.
1010

1111
## Integrate SDK
1212

@@ -105,6 +105,8 @@ It is recommended to set global attributes when initializing the SDK, global att
105105

106106
You can add the following code to log an event with an item.
107107

108+
**Note: Only pipelines from version 1.1+ can handle items with custom attribute.**
109+
108110
```typescript
109111
import { ClickstreamAnalytics, Item } from '@aws/clickstream-web';
110112

@@ -113,6 +115,7 @@ const itemBook: Item = {
113115
name: 'Nature',
114116
category: 'book',
115117
price: 99,
118+
book_publisher: "Nature Research",
116119
};
117120
ClickstreamAnalytics.record({
118121
name: 'view_item',

0 commit comments

Comments
 (0)