From e438749f8a508a20c8bbaaf243885a849e37fdb2 Mon Sep 17 00:00:00 2001 From: calise cheung Date: Wed, 22 Sep 2021 09:43:52 -0700 Subject: [PATCH 1/2] Update Edge Wrapper Readme Update Edge Wrapper Readme --- packages/edge/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/packages/edge/README.md b/packages/edge/README.md index 1051dbb8..a441c5fe 100644 --- a/packages/edge/README.md +++ b/packages/edge/README.md @@ -4,8 +4,28 @@ [![npm version](https://badge.fury.io/js/%40adobe%2Freact-native-aepedge.svg)](https://www.npmjs.com/package/@adobe/react-native-aepedge) [![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepedge)](https://www.npmjs.com/package/@adobe/react-native-aepedge) +`@adobe/react-native-aepedge` is a wrapper around the iOS and Android [Adobe Experience Platform Edge Network](https://aep-sdks.gitbook.io/docs/foundation-extensions/experience-platform-extension) to allow for integration with React Native applications. + +## Prerequisites + +The Edge Network extension has the following peer dependencies, which must be installed prior to installing the messaging extension: +- [Core](../core/README.md) +- [Edge Identity](../edgeidentity/README.md) + +## Installation + +See [Requirements and Installation](https://github.com/adobe/aepsdk-react-native#requirements) instructions on the main page + +Install the `@adobe/react-native-aepedge` package: + +```bash +cd MyReactApp +npm install @adobe/react-native-aepedge +``` ## Usage +### [Adobe Experience Platform Edge Network](https://aep-sdks.gitbook.io/docs/foundation-extensions/experience-platform-extension) + ### Initializing: Initializing the SDK should be done in native code, documentation on how to initialize the SDK can be found [here](https://github.com/adobe/aepsdk-react-native#initializing). @@ -76,8 +96,6 @@ public class MainApplication extends Application implements ReactApplication { } ``` -### [Edge Network](https://aep-sdks.gitbook.io/docs/foundation-extensions/experience-platform-extension) - #### Importing the extension: ```javascript import {AEPEdge, AEPExperienceEvent} from '@adobe/react-native-aepedge'; From c93100d098adacff67efd71f10f93db618016df0 Mon Sep 17 00:00:00 2001 From: calise cheung Date: Wed, 22 Sep 2021 09:59:10 -0700 Subject: [PATCH 2/2] update readme update readme --- packages/edge/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/edge/README.md b/packages/edge/README.md index a441c5fe..b76dcbe6 100644 --- a/packages/edge/README.md +++ b/packages/edge/README.md @@ -10,7 +10,7 @@ The Edge Network extension has the following peer dependencies, which must be installed prior to installing the messaging extension: - [Core](../core/README.md) -- [Edge Identity](../edgeidentity/README.md) +- [Identity for Edge Network](../edgeidentity/README.md) ## Installation