Skip to content
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.

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

Clarify relation to AEM #4

Open
kwin opened this issue Sep 24, 2023 · 0 comments
Open

Clarify relation to AEM #4

kwin opened this issue Sep 24, 2023 · 0 comments

Comments

@kwin
Copy link
Member

kwin commented Sep 24, 2023

Currently the readme does only mention AEM once (https://github.com/Netcentric/component-loader/blob/03239e82f3e6413e38fa2fdcdf828aa2f0ad343c/README.md) in

Problem: Mutation Observer vs AEM edit Iframe Postmessage
Solution: Mutation Observer

It would be good to explicitly mention dependencies to AEM (if there are any) and explicitly mention the AEM use case (as that is what this library is primarily used for up till now). In general some introduction would be necessary to outline the goals of this library.

Also the existing headlines in the reade need some refactoring, currently there is Table of contents with children Installation, Usage and Example and API and examples with lots of children, also unrelated ones like Docs, Issue templates and some more which should probably go into a dedicated Contribution section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant