Skip to content

Commit 91fed37

Browse files
committed
Update project title and meta: clarified AnimText.js purpose and improved SEO
1 parent 5a9ca31 commit 91fed37

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# Amazing Text & Letter Animations
1+
# AnimText.js – Lightweight JavaScript Library for Letter, Word & Line Animations
22

3-
![Plugin](https://img.shields.io/badge/Type-Text%20Enhancer-4B9CE2?style=for-the-badge)
43
![Vanilla JS](https://img.shields.io/badge/JS-Vanilla%20JS-brightgreen?style=for-the-badge)
54
![No Dependencies](https://img.shields.io/badge/Dependencies-None-lightgrey?style=for-the-badge)
6-
[![Built for](https://img.shields.io/badge/Built%20for-cssanimation-blueviolet?style=for-the-badge)](https://github.com/yesiamrocks/cssanimation)
75
[![npm](https://img.shields.io/npm/v/animtext?style=for-the-badge)](https://www.npmjs.com/package/animtext)
86
[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/animtext?style=for-the-badge)](https://www.jsdelivr.com/package/npm/animtext)
97
[![unpkg](https://img.shields.io/badge/CDN-unpkg-blue?style=for-the-badge)](https://unpkg.com/browse/animtext/)
108
[![View Demo](https://img.shields.io/badge/🎬%20Live-Demo-green?style=for-the-badge)](https://yesiamrocks.github.io/animtext/)
9+
[![Made for {css}animation](https://img.shields.io/badge/Made%20for-{css}animation-7e2ea0?style=for-the-badge&logo=css3&logoColor=white)](https://github.com/yesiamrocks/cssanimation)
1110

1211
**AnimText** is a lightweight JavaScript enhancer for animating text with **letter-by-letter, word-by-word, and line-by-line** animations to your projects. It's designed to work seamlessly with [{css}animation](https://github.com/yesiamrocks/cssanimation), for robust and customizable text effects.
1312

@@ -104,7 +103,7 @@ This will animate the letters of the heading using your chosen animation class.
104103
</h2>
105104
```
106105

107-
## 1. Letter Animation Usage
106+
## Letter Animation Usage
108107

109108
Animate text one letter at a time with different sequencing styles:
110109

@@ -132,15 +131,15 @@ Animate text one letter at a time with different sequencing styles:
132131

133132
---
134133

135-
## 2. Word-by-Word Animation `data-at-word`
134+
## Word-by-Word Animation `data-at-word`
136135

137136
```html
138137
<h2 class="cssanimation" data-at-word="ca__fx-fadeIn">
139138
Each word animates uniquely
140139
</h2>
141140
```
142141

143-
## 3. Line-by-line Animation `data-at-line`
142+
## Line-by-line Animation `data-at-line`
144143

145144
```html
146145
<p class="cssanimation" data-at-line="ca__fx-fadeIn">
@@ -184,7 +183,7 @@ You don't need to add `data-at-separator` for `<br>` or newlines, this is the **
184183

185184
[Check out this Text & Letter Animations Preview Tool to easily generate the animation code for your text.](https://yesiamrocks.github.io/cssanimation/text-animation.html)
186185

187-
## `data-at-delay`
186+
## Animation Delay
188187

189188
The `data-at-delay` attribute specifies the delay before each animated unit (letter, word, or line) begins its animation. The values are in milliseconds (ms).
190189

@@ -206,7 +205,7 @@ The `data-at-delay` attribute specifies the delay before each animated unit (let
206205

207206
This allows you to create rhythmic or staggered entry effects easily, like `data-at-delay="50 100 100"` as in your example. The first unit gets 50ms delay, and all subsequent units get 100ms delay.
208207

209-
## `data-at-base-duration`
208+
## Animation Base Duration`
210209

211210
The `data-at-base-duration` attribute provides a simple way to set a global default animation duration for all units (letters, words, or lines) in milliseconds (ms).
212211

@@ -236,5 +235,3 @@ This means `data-at-base-duration` gives you a convenient way to set a project-w
236235
- If you pass more classes or values than needed, the extra elements are skipped, and a warning might be logged to your console to help with debugging.
237236
- Delay and duration values are parsed safely; non-numeric strings will fall back to default behaviors to prevent errors.
238237
- Animation duration is determined in this order of precedence: `data-at-base-duration` > CSS-detected duration > internal default.
239-
240-
[← Return to the main README](./README.md)

0 commit comments

Comments
 (0)