Skip to content

Commit 4375690

Browse files
committed
docs(readme): add community support section, improve copy, and update badges
- Added detailed sections for: - Contributing guidelines - Bug reporting & discussion links - Support via Buy Me a Coffee and Membership - Community Sponsorship benefits - Improved project description for clarity and appeal - Updated and reorganized README badges - Refined tone to align with personal brand and open-source spirit
1 parent 7f29da6 commit 4375690

File tree

8 files changed

+181
-1
lines changed

8 files changed

+181
-1
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
buy_me_a_coffee: yesiamrocks
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## What’s Changed
2+
3+
Brief summary of what this PR does. If it fixes a bug or adds a new animation, mention it here.
4+
5+
## ✅ Checklist
6+
7+
- [ ] I’ve followed the contribution guidelines (`CONTRIBUTING.md`)
8+
- [ ] My code follows the style guide
9+
- [ ] I’ve tested this locally
10+
- [ ] I’ve documented my changes if needed
11+
12+
Fixes #
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "\U0001F41E Bug Report"
3+
about: Report a problem or unexpected behavior in cssanimation.io
4+
title: "[BUG] "
5+
labels: bug
6+
---
7+
8+
**Describe the bug**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior.
13+
14+
**Expected behavior**
15+
What did you expect to happen?
16+
17+
**Screenshots / Code / URL**
18+
If applicable, add screenshots or a code snippet.
19+
20+
**Environment**
21+
- OS:
22+
- Browser:
23+
- Version:
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: "\u2728 Feature Request"
3+
about: Suggest an improvement or animation idea
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
---
7+
8+
**Describe the feature**
9+
What should it do?
10+
11+
**Use case**
12+
Why is this needed or helpful?
13+
14+
**Any visual reference?**
15+
(Optional) Share links, animations, or mockups if relevant.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Sponsor Shoutout
2+
description: Submit your info for a shoutout in the newsletter and project documentation
3+
title: '✨ Sponsor Shoutout Request'
4+
labels: ['sponsor', 'community']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for becoming a sponsor! 💛
10+
Fill out the info below so I can include your shoutout in **Pixels & Projects with Pavel** and/or in the docs of my open-source libraries.
11+
12+
- type: input
13+
id: name
14+
attributes:
15+
label: Your Name or Handle
16+
placeholder: e.g., Jane Doe / @janedev
17+
validations:
18+
required: true
19+
20+
- type: input
21+
id: project
22+
attributes:
23+
label: Project/Website you'd like me to link
24+
placeholder: e.g., https://janedev.io or GitHub repo
25+
validations:
26+
required: false
27+
28+
- type: input
29+
id: avatar
30+
attributes:
31+
label: Avatar or Logo URL (optional)
32+
placeholder: Paste a link to your logo or avatar image (e.g., Twitter, GitHub, CDN)
33+
validations:
34+
required: false
35+
36+
- type: input
37+
id: social
38+
attributes:
39+
label: Social handle you'd like mentioned (optional)
40+
placeholder: e.g., Twitter, LinkedIn, GitHub, etc.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: message
46+
attributes:
47+
label: Optional message or context you'd like me to include
48+
placeholder: e.g., “Using {css}animation on a new design portfolio project!”
49+
validations:
50+
required: false

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Changelog
22

3+
## [1.1.4] - 2025-08-07
4+
5+
### Added
6+
7+
- “Support This Project” and “Become a Community Sponsor” sections with clear benefits and heartfelt messaging.
8+
- Calls-to-action for GitHub Issues, Discussions, and Pull Requests.
9+
- Newsletter promotion with badge and link to "Pixels & Projects with Pavel".
10+
11+
### Improved
12+
13+
- Enhanced project intro for clarity and developer appeal.
14+
- Reorganized README badge layout for better scannability.
15+
- Final emotional note and signature with contact/social badges.
16+
317
## [1.1.3] - 2025-07-23
418

519
### Changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
[![View Demo](https://img.shields.io/badge/🎬%20Live-Demo-green?style=for-the-badge)](https://yesiamrocks.github.io/animtext/)
1010
[![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)
1111

12+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support%20My%20Work-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=white)](https://www.buymeacoffee.com/yesiamrocks) [![Join Membership](https://img.shields.io/badge/Become%20a%20Member-Monthly%20Support-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=white)](https://www.buymeacoffee.com/yesiamrocks/membership)
13+
1214
**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.
1315

1416
**AnimText** is a lightweight, dependency-free JavaScript library designed to make precise letter-by-letter, word-by-word, and line-by-line text animations incredibly simple. Forget complex JavaScript or heavy frameworks; AnimText empowers you to create stunning, dynamic text effects using nothing but intuitive **HTML data attributes**.
@@ -397,3 +399,66 @@ Put this in your index.html:
397399
</body>
398400
</html>
399401
```
402+
403+
## Contribute
404+
405+
We welcome all contributions — whether it’s fixing bugs, adding feature, improving docs, or sharing ideas!
406+
407+
- Found an issue? [Open a GitHub Issue](https://github.com/yesiamrocks/animtext/issues)
408+
- Want to improve the library? [Submit a Pull Request](https://github.com/yesiamrocks/animtext/pulls)
409+
- Have questions or feature ideas? [Start a Discussion](https://github.com/yesiamrocks/animtext/discussions)
410+
411+
Help us make **AnimText** even more magical for everyone.
412+
413+
## Need Help?
414+
415+
Running into issues while using **AnimText** in your project?
416+
Whether it's a website, landing page, tool, or framework integration, we're here to help!
417+
418+
- Report bugs or problems via [GitHub Issues](https://github.com/yesiamrocks/animtext/issues)
419+
- Ask questions or get guidance in [GitHub Discussions](https://github.com/yesiamrocks/animtext/discussions)
420+
421+
We’re happy to assist and make sure everything works smoothly in your setup.
422+
423+
## Support This Project
424+
425+
If **AnimText** has saved you time, added a little magic to your UI, or helped bring your creative vision to life — please consider supporting its development.
426+
427+
This project is built with care, during late nights and weekends, with a passion for open-source and motion design. Your support helps me:
428+
429+
- Keep the library up to date and bug-free
430+
- Add new features and animation triggers
431+
432+
Every coffee counts — thank you for helping me keep creating. 🙏
433+
434+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support%20My%20Work-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=white)](https://www.buymeacoffee.com/yesiamrocks)
435+
436+
## Become a Community Sponsor
437+
438+
If **AnimText** helped you ship faster, spark delight in your UI, or just made your day as a developer easier — I’d be honored to have your support.
439+
440+
This isn’t a big team or a funded project. It’s just me — **Pavel** — building tools I wish existed.
441+
From late nights to early mornings, I pour love into every animation, every feature, every detail — to make the creative process more fun, expressive, and empowering for makers like you.
442+
443+
Your sponsorship helps me:
444+
445+
- Keep the library free and open for everyone
446+
- Push out new triggers, animation packs, and ideas faster
447+
- Write thoughtful dev/design content via my newsletter
448+
👉 [Pixels & Projects with Pavel](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/)
449+
450+
### As a Community Sponsor, you'll receive:
451+
452+
- A shoutout in the newsletter
453+
- Your name or project proudly featured in the documentation and site
454+
- My sincere gratitude for backing indie creativity on the web
455+
456+
Let’s build a more playful, animated web — together.
457+
458+
[![Join Membership](https://img.shields.io/badge/Become%20a%20Member-Monthly%20Support-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=white)](https://www.buymeacoffee.com/yesiamrocks/membership)
459+
460+
<br>
461+
462+
---
463+
464+
![Built with ❤️ by Pavel](https://img.shields.io/badge/Built%20with-%E2%9D%A4%EF%B8%8F%20by%20Pavel-orange?style=for-the-badge) [![LinkedIn](https://img.shields.io/badge/LinkedIn-@shafayetul-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/shafayetul/) [![Twitter](https://img.shields.io/badge/Twitter-@yesiamrocks-1DA1F2?style=for-the-badge&logo=x&logoColor=white)](https://twitter.com/yesiamrocks) [![Email](https://img.shields.io/badge/Email-yesiamrocks@gmail.com-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:yesiamrocks@gmail.com) [![Newsletter](https://img.shields.io/badge/Pixels_&_Projects_with_Pavel-Subscribe-a6ca4b?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "animtext",
3-
"version": "1.1.3",
3+
"version": "1.1.4",
44
"type": "module",
55
"description": "AnimText is a JavaScript library for letter, word, & line animations. Easily create dynamic text effects with simple HTML data attributes.",
66
"main": "dist/animtext.js",

0 commit comments

Comments
 (0)