Skip to content

fix: update package name references #200

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

Open
grahamcrackers wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −12
Open

fix: update package name references #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/storefront-events-collector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ The collector can be used as a hosted script, or bundled in a JavaScript applica
To load the Collector as a script, use the following snippet.

```
<script src="https://cdn.jsdelivr.net/npm/@adobe/commerce-events-collectors/dist/index.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@adobe/magento-storefront-event-collector/dist/index.js"></script>
```

To install the script as a dependency, run this command.

```shell
npm install @adobe/commerce-events-collectors
npm install @adobe/magento-storefront-event-collector
```

## Quick start

After loading the collector script, or importing the package as shown below, there is nothing else that needs to be done.

```javascript
import "@adobe/commerce-events-collectors";
import "@adobe/magento-storefront-event-collector";
```

## Usage
Expand Down Expand Up @@ -301,15 +301,15 @@ If you have any questions or encounter any issues, please reach out at these loc

- [GitHub][issues]

[npm]: https://npmjs.com/package/@adobe/commerce-events-collectors
[npm]: https://npmjs.com/package/@adobe/magento-storefront-event-collector
[version-badge]: https://img.shields.io/npm/v/@adobe/magento-storefront-event-collector.svg?style=flat-square
[downloads-badge]: https://img.shields.io/npm/dt/@adobe/magento-storefront-event-collector?style=flat-square
[bundlephobia]: https://bundlephobia.com/result?p=@adobe/magento-storefront-event-collector
[size-badge]: https://img.shields.io/bundlephobia/minzip/@adobe/magento-storefront-event-collector?style=flat-square
[actions]: https://github.com/adobe/commerce-events/actions
[build-badge]: https://img.shields.io/github/workflow/status/adobe/magento-storefront-event-collector/merge-to-main?style=flat-square
[typescript]: https://typescriptlang.org/dt/search?search=%40adobe%2Fcommerce-events-collectors
[typescript-badge]: https://img.shields.io/npm/types/@adobe/commerce-events-collectors?style=flat-square
[typescript]: https://typescriptlang.org/dt/search?search=%40adobe%2Fmagento-storefront-event-collector
[typescript-badge]: https://img.shields.io/npm/types/@adobe/magento-storefront-event-collector?style=flat-square
[contributing]: https://github.com/adobe/commerce-events/blob/main/.github/CONTRIBUTING.md
[contributing-badge]: https://img.shields.io/badge/PRs-welcome-success?style=flat-square
[sdk]: https://npmjs.com/package/@adobe/magento-storefront-events-sdk
Expand Down
2 changes: 1 addition & 1 deletion packages/storefront-events-collector/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"type": "git",
"url": "git+https://github.com/adobe/commerce-events"
},
"homepage": "https://github.com/adobe/commerce-events/tree/main/packages/commerce-events-collectors#readme",
"homepage": "https://github.com/adobe/commerce-events/tree/main/packages/storefront-events-collector#readme",
"bugs": {
"url": "https://github.com/adobe/commerce-events/issues"
},
Expand Down
10 changes: 5 additions & 5 deletions packages/storefront-events-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ This SDK can be used as a hosted script, or bundled in a JavaScript application.
To load the SDK as a script, use the following snippet.

```
<script src="https://cdn.jsdelivr.net/npm/@adobe/commerce-events-sdk/dist/index.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@adobe/magento-storefront-events-sdk/dist/index.js"></script>
```

To install the script as a dependency, run this command.

```shell
npm install @adobe/commerce-events-sdk
npm install @adobe/magento-storefront-events-sdk
```

## Quick start
Expand All @@ -50,7 +50,7 @@ Below is a code example of how to get started.
**IMPORTANT** Relevant context data must be populated before publishing events that require it.

```javascript
import mse from "@adobe/commerce-events-sdk";
import mse from "@adobe/magento-storefront-events-sdk";
// handler - can go in a different module
function addToCartHandler(event) {
// do something with the event
Expand Down Expand Up @@ -134,8 +134,8 @@ If you have any questions or encounter any issues, please reach out on [GitHub][
[size-badge]: https://img.shields.io/bundlephobia/minzip/@adobe/magento-storefront-events-sdk?style=flat-square
[actions]: https://github.com/adobe/commerce-events/actions
[build-badge]: https://img.shields.io/github/workflow/status/adobe/commerce-events/publish-latest?style=flat-square
[typescript]: https://typescriptlang.org/dt/search?search=%40adobe%2Fcommerce-events-sdk
[typescript-badge]: https://img.shields.io/npm/types/@adobe/commerce-events-sdk?style=flat-square
[typescript]: https://typescriptlang.org/dt/search?search=%40adobe%2Fmagento-storefront-events-sdk
[typescript-badge]: https://img.shields.io/npm/types/@adobe/magento-storefront-events-sdk?style=flat-square
[contributing]: https://github.com/adobe/commerce-events/blob/main/.github/CONTRIBUTING.md
[contributing-badge]: https://img.shields.io/badge/PRs-welcome-success?style=flat-square
[commerce]: https://business.adobe.com/products/magento/magento-commerce.html
Expand Down