From 96601ce9a08ebd3f61fa3da550f984b2b0a199bf Mon Sep 17 00:00:00 2001 From: Zoffix Znet Date: Wed, 3 Jun 2020 16:47:37 -0400 Subject: [PATCH] Warn of invalid markup generation (#30) Fixes https://github.com/pshihn/rough-notation/issues/29 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 10cf31d..30b219a 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ const annotation = annotate(e, { type: 'underline' }); annotation.show(); ``` +The annotation element will be created as a sibling to the element passed to the annotate, as such certain elements, like ``, are not suitable for annotation. Create an inner `` or `
` and annotate that instead. + ## Annotation Group rough-notation provides a way to order the animation of annotations by creating an annotation-group. Pass the list of annotations to create a group. When show is called on the group, the annotations are animated in order.