diff --git a/README.md b/README.md index 8761775..eb7a5fc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Vanilla+ -**WARNING: PROOF OF CONCEPT ONLY!** An eventual version 1.0 is expected by 2023. This is a back-burner project for me as of 2022. +**WARNING: CURRENTLY AT THE PROTOTYPE STAGE!** An eventual version 1.0 is expected by 2023. This is a back-burner project for me as of 2022. [![license](https://img.shields.io/github/license/vphantom/vpweb.svg?style=plastic)]() [![GitHub release](https://img.shields.io/github/release/vphantom/vpweb.svg?style=plastic)]() @@ -58,6 +58,10 @@ import 'vpweb/vpweb'; ``` +You may also use individual components, although if you use more than one as stand-alone scripts, there will be some redundancy. + +Note that components triggered by attributes or class names cannot self-activate inside shadow DOMs. If you want to use Vanilla+ components inside those, you'll need to activate them manually (for example, with `fast.preclick(element)`). See each component's documentation below for manual activation usage. + ### [Editeur](docs/editeur.md) ### [Fast Clicks](docs/fast.md) diff --git a/docs/editeur.md b/docs/editeur.md index 4329357..b797eb8 100644 --- a/docs/editeur.md +++ b/docs/editeur.md @@ -27,6 +27,8 @@ Example usage: ``` +This is a custom element and is thus available inside shadow DOMs. + The optional JSON scripts may be inline or referenced with `src`, in which case they will be loaded asynchronously. Without `vp-name` is read-only mode, in which case `