docs(readme): add animation info and clarify CJT locales

Author: raffaele-filiberti

README.md

@@ -3,7 +3,7 @@
 Features:
 
 - splitting text into lines, words, and chars
-- support for CJT languages (Traditional/Simplified Chinese, Japanese, Korean, etc)
+- support for CJT languages (Traditional/Simplified Chinese, Japanese, Korean, Thai)
 - nested HTML elements (with all the types of splits)
 - text balancing
 - accessibility
@@ -25,6 +25,20 @@ import SplitText from '@activetheory/split-text';
 const el = document.querySelector('.el');
 
 const splitTextInstance = new SplitText(el);
+
+console.log(splitTextInstance.lines);
+console.log(splitTextInstance.words);
+console.log(splitTextInstance.chars);
+
+// Useful for animations purposes
+for (const line of splitTextInstance.lines) {
+  console.log(line.__words);
+  console.log(line.__wordCount);
+}
+
+for (const word of splitTextInstance.words) {
+  console.log(word.__lineIndex);
+}
 ```
 
 ## Options
@@ -61,4 +75,6 @@ To run the demo, run `npm run dev`.
 ### CJT locales
 
 The `handleCJT` option will leverage `​` to split the text properly.
+This library does not handle this automatically, you need to manually add `​` in your text.
+However, it's not mandatory, you can still use the library without it and most of the time it will work nicely.
 We suggest to have a look at https://github.com/google/budoux/ for more information about how to place `​` in your text.

demo/index.js

@@ -88,7 +88,7 @@ document.addEventListener('DOMContentLoaded', () => {
   // Initial text
   inputText.value = [
     /*html*/ `<h1>split anything 🐳 🍔 🍕 into words, chars, lines</h1>`,
-    /*html*/ `<p>Try typing some text here to see it split into lines, words, and characters!</p>`,
+    /*html*/ `<p>Try typing some text <a href="https://www.google.com">here</a> to see it split into lines, words, and characters!</p>`,
     /*html*/ `<ul>`,
     /*html*/ `  <li>pizza <b>margherita</b></li>`,
     /*html*/ `  <li>hamburger</li>`,