Update README - "About this project" #504
Conversation
* commit 'c9abdd670e602c515889a94b189dab6b18887291': Update release.yml Update release.yml Improve CI/CD (adobe#502) # Conflicts: # .github/workflows/release.yml
README.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| # AEPCore | |||
| # Adobe Experience Platform SDK | |||
There was a problem hiding this comment.
Should this be Adobe Experience Platform Core SDK?
README.md
Outdated
| @@ -15,8 +15,12 @@ By using the Beta, you hereby acknowledge that the Beta is provided "as is" with | |||
|
|
|||
| ## About this project | |||
|
|
|||
| The Mobile Core represents the core Adobe Experience Platform SDK that is required for every app implementation. The core contains a common set of functionality and frameworks, such as Experience Cloud Identity services, data event hub, Rules Engine, reusable networking, disk access routines, and so on, which are required by all Adobe and third-party extensions. | |||
| `AEPCore`, `AEPService`, `AEPIdentity` represent the core Adobe Experience Platform SDK that are required for every app implementation. The core extensions contain a common set of functionality and frameworks, such as Experience Cloud Identity services, data event hub, reusable networking, disk access routines, and so on, which are required by all Adobe and third-party extensions. | |||
There was a problem hiding this comment.
...represent the core Adobe Experience Platform SDK extensions that...
README.md
Outdated
|
|
||
| `AEPSignal` represents the Adobe Experience Platform SDK `Signal` extension that allows marketers to send a "signal" to their apps through the Experience Platform SDKs. |
There was a problem hiding this comment.
Should we rephrase this to provide some more info?
`AEPSignal` represents the Adobe Experience Platform SDK's `Signal` extension that allows marketers to send a "signal" to their apps to send data to external destinations or to open URLs.
README.md
Outdated
| `AEPSignal` represents the Adobe Experience Platform SDK `Signal` extension that allows marketers to send a "signal" to their apps through the Experience Platform SDKs. | ||
|
|
||
|
|
||
| `AEPLifecycle` represents the Adobe Experience Platform SDK `Lifecycle` extension that provides out-of-the-box, application lifecycle information about your app user. |
There was a problem hiding this comment.
`AEPLifecycle` represents the Adobe Experience Platform SDK's `Lifecycle` extension that helps collect application Lifecycle metrics such as, application install or upgrade information, application launch and session information, device information, and any additional context data provided by the application developer.
README.md
Outdated
| @@ -15,8 +15,12 @@ By using the Beta, you hereby acknowledge that the Beta is provided "as is" with | |||
|
|
|||
| ## About this project | |||
|
|
|||
| The Mobile Core represents the core Adobe Experience Platform SDK that is required for every app implementation. The core contains a common set of functionality and frameworks, such as Experience Cloud Identity services, data event hub, Rules Engine, reusable networking, disk access routines, and so on, which are required by all Adobe and third-party extensions. | |||
| `AEPCore`, `AEPService`, `AEPIdentity` represent the core Adobe Experience Platform SDK extensions that are required for every app implementation. The core extensions contain a common set of functionality and frameworks, such as Experience Cloud Identity services, data event hub, reusable networking, disk access routines, and so on, which are required by all Adobe and third-party extensions. | |||
There was a problem hiding this comment.
@sbenedicadb do you want to provide better wordings for this segment?
There was a problem hiding this comment.
The AEPCore, AEPServices, and AEPIdentity extensions represent the foundation of the Adobe Experience Platform SDK - every app using the SDK must include them. These modules contain a common set of functionality and services which are required by all SDK extensions.
AEPCore contains implementation of the Event Hub. The Event Hub is the mechanism used for delivering events between the app and the SDK. The Event Hub is also used for sharing data between extensions.
AEPServices provides several reusable implementations needed for platform support, including networking, disk access, and database management.
AEPIdentity implements the integration with Adobe Experience Platform Identity services.
.github/workflows/release.yml
Outdated
| required: true | ||
| default: 'yes' | ||
|
|
||
| release_AEPService: |
There was a problem hiding this comment.
Let's rename this to release_AEPServices:
There was a problem hiding this comment.
@swarna04 I'd update it in a separate PR since it's not related to documentation changes.
.github/workflows/release.yml
Outdated
| default: 'yes' | ||
|
|
||
| release_AEPService: | ||
| description: 'release AEPService ("no" to skip)' |
| @@ -1,4 +1,4 @@ | |||
| # AEPCore | |||
| # Adobe Experience Platform Core SDK | |||
|
|
|||
| <!-- | |||
| on [](https://cocoapods.org/pods/AEPCore) | |||
There was a problem hiding this comment.
when we add the cocoapods badges up here, let's make sure we add them for each of the extensions in this repo
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: