Skip to content

Commit 45d348b

Browse files
committed
docs(readme): improve contribution, license, and community sections
- Rewrote "Contribute" section with clear links and friendly tone - Added simplified explanation and link to LICENSE-summary.md - Enhanced accessibility and sponsorship sections - Added badges for license and attribution - Updated community support message with GitHub links
1 parent 3be2a1c commit 45d348b

File tree

75 files changed

+10924
-10822
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+10924
-10822
lines changed

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
# [6.11.4] – 2025-07-31
2+
3+
### Documentation Improvements
4+
5+
- Rewrote the **Contribute** section with clearer language and developer-friendly tone
6+
- Added a new [`LICENSE-summary.md`](./LICENSE-summary.md) for a explanation of Apache 2.0 license terms and attribution requirements
7+
- Linked the license summary in the main README under the License section
8+
- Improved the **Accessibility**, **Changelog Highlights**, and **Support** sections for readability and structure
9+
- Added new badges:
10+
![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
11+
![Attribution Required](https://img.shields.io/badge/Attribution-Required-important)
12+
13+
### Community & Support
14+
15+
- Updated community callout for developers using `{css}animation` in websites, tools, or frameworks
16+
- Encouraged contributions and feedback via [GitHub Issues](https://github.com/yesiamrocks/cssanimation/issues) and [Discussions](https://github.com/yesiamrocks/cssanimation/discussions)
17+
18+
Thanks to everyone supporting and using **{css}animation**! Let’s keep building magical motion for the web.
19+
120
## [6.11.3] – 2025-07-31
221

322
### Added

LICENSE-summary.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# {css}animation - License Summary
2+
3+
![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg) ![Attribution Required](https://img.shields.io/badge/Attribution-Required-important)
4+
5+
**License:** [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
6+
**Author:** Shafayetul Islam Pavel
7+
**Project:** [cssanimation.io](https://cssanimation.io)
8+
**Repository:** [yesiamrocks/cssanimation](https://github.com/yesiamrocks/cssanimation)
9+
10+
## What You Can Do
11+
12+
- ✔️ Use this library in **personal**, **commercial**, or **client** projects
13+
- ✔️ Modify or extend the code for your own needs
14+
- ✔️ Include it in websites, apps, design systems, or frameworks
15+
- ✔️ Share or redistribute it (even with changes), **as long as attribution is preserved**
16+
17+
## What You Can’t Do
18+
19+
-**Remove** the LICENSE or NOTICE files when sharing or forking the project
20+
-**Misrepresent** the origin of the library
21+
-**Imply endorsement** by the original author without permission
22+
- ❌ Expect **any warranty** — this software is provided _as-is_
23+
24+
## Required Attribution
25+
26+
If you reuse, remix, or redistribute this library, you **must include**:
27+
28+
- The [LICENSE](./LICENSE) file
29+
- The [NOTICE](./NOTICE) file (credits the author and outlines usage rights)
30+
31+
## Need Help?
32+
33+
Have questions about licensing or using this project in your work?
34+
35+
- Open an [issue](https://github.com/yesiamrocks/cssanimation/issues)
36+
- Start a [discussion](https://github.com/yesiamrocks/cssanimation/discussions)
37+
38+
Thanks for using **{css}animation**!

README.md

Lines changed: 44 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# CSS Animation Library for Developers and Ninjas - {css}animation
22

3-
> A Powerful CSS Animation Library for Advanced Motion Design.
4-
53
<!-- Tech & Status -->
64

7-
![CSS](https://img.shields.io/badge/style-CSS-blue?style=for-the-badge) ![No Dependencies](https://img.shields.io/badge/Dependencies-None-lightgrey?style=for-the-badge) [![NPM](https://img.shields.io/npm/v/@hellouxpavel%2Fcssanimation.svg?style=for-the-badge)](https://www.npmjs.com/package/@hellouxpavel/cssanimation) ![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=for-the-badge) [![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/@hellouxpavel/cssanimation?style=for-the-badge)](https://www.jsdelivr.com/package/npm/@hellouxpavel/cssanimation) [![unpkg](https://img.shields.io/badge/CDN-unpkg-blue?style=for-the-badge)](https://unpkg.com/browse/@hellouxpavel/cssanimation/) [![GitHub issues](https://img.shields.io/github/issues/yesiamrocks/cssanimation?style=for-the-badge)](https://github.com/yesiamrocks/cssanimation/issues) [![GitHub stars](https://img.shields.io/github/stars/yesiamrocks/cssanimation?style=for-the-badge)](https://github.com/yesiamrocks/cssanimation/stargazers) [![Live Demo](https://img.shields.io/badge/demo-online-brightgreen?style=for-the-badge)](https://yesiamrocks.github.io/cssanimation/index.html) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@hellouxpavel/cssanimation?style=for-the-badge)](https://bundlephobia.com/result?p=@hellouxpavel/cssanimation) ![Made with Love](https://img.shields.io/badge/Made%20with-%E2%9D%A4-red?style=for-the-badge) [![Triggle JS](https://img.shields.io/badge/Triggle%20JS-00c853?style=for-the-badge&logo=flash&logoColor=white)](https://github.com/yesiamrocks/triggle) [![AnimText](https://img.shields.io/badge/AnimText%20JS-22d3ee?style=for-the-badge&logo=typography&logoColor=white)](https://github.com/yesiamrocks/animtext) [![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20me%20a%20coffee-ffdd00?logo=buy-me-a-coffee&logoColor=000000&style=for-the-badge)](https://www.buymeacoffee.com/yesiamrocks) [![Sponsor](https://img.shields.io/badge/Sponsor-%E2%98%95-lightgrey?style=for-the-badge&logo=buy-me-a-coffee)](https://buymeacoffee.com/yesiamrocks/membership) [![Newsletter](https://img.shields.io/badge/Subscribe-Pixels%20&%20Projects%20-A6CA4B?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/)
5+
![CSS](https://img.shields.io/badge/style-CSS-blue?style=for-the-badge) ![No Dependencies](https://img.shields.io/badge/Dependencies-None-lightgrey?style=for-the-badge) [![NPM](https://img.shields.io/npm/v/@hellouxpavel%2Fcssanimation.svg?style=for-the-badge)](https://www.npmjs.com/package/@hellouxpavel/cssanimation) ![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=for-the-badge) [![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/@hellouxpavel/cssanimation?style=for-the-badge)](https://www.jsdelivr.com/package/npm/@hellouxpavel/cssanimation) [![unpkg](https://img.shields.io/badge/CDN-unpkg-blue?style=for-the-badge)](https://unpkg.com/browse/@hellouxpavel/cssanimation/) [![GitHub issues](https://img.shields.io/github/issues/yesiamrocks/cssanimation?style=for-the-badge)](https://github.com/yesiamrocks/cssanimation/issues) [![GitHub stars](https://img.shields.io/github/stars/yesiamrocks/cssanimation?style=for-the-badge)](https://github.com/yesiamrocks/cssanimation/stargazers) [![Live Demo](https://img.shields.io/badge/demo-online-brightgreen?style=for-the-badge)](https://yesiamrocks.github.io/cssanimation/index.html) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@hellouxpavel/cssanimation?style=for-the-badge)](https://bundlephobia.com/result?p=@hellouxpavel/cssanimation) ![Made with Love](https://img.shields.io/badge/Made%20with-%E2%9D%A4-red?style=for-the-badge) [![Triggle JS](https://img.shields.io/badge/Triggle%20JS-00c853?style=for-the-badge&logo=flash&logoColor=white)](https://github.com/yesiamrocks/triggle) [![AnimText](https://img.shields.io/badge/AnimText%20JS-22d3ee?style=for-the-badge&logo=typography&logoColor=white)](https://github.com/yesiamrocks/animtext)
6+
7+
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20me%20a%20coffee-ffdd00?logo=buy-me-a-coffee&logoColor=000000&style=for-the-badge)](https://www.buymeacoffee.com/yesiamrocks) [![Sponsor](https://img.shields.io/badge/Sponsor-%E2%98%95-lightgrey?style=for-the-badge&logo=buy-me-a-coffee)](https://buymeacoffee.com/yesiamrocks/membership)
8+
9+
> A Powerful CSS Animation Library for Advanced Motion Design. Zero JS Required. Over 500 Effects, Letter, Word & Line Stagger Animations, Utilities, and easy CDN or NPM Install.
810
9-
<a href="https://yesiamrocks.github.io/cssanimation/index.html" target="_bank"><img src="./branding/cssanimation-logo.svg" width="250" style="margin:10px 0 10px 0"></a>
11+
<a href="https://yesiamrocks.github.io/cssanimation/index.html" target="_bank"><img src="./branding/cssanimation-logo.svg" width="250" style="margin:10px 0 5px 0"></a>
1012

1113
**{css}animation** is a lightweight, modular CSS animation library built for front-end developers, creative coders, and UI ninjas. Get access to **A Rich Set of Ready-to-Use Animation Classes** to bring your interfaces to life. From simple fades and zooms to dynamic letter effects and 3D transitions, we’ve got your motion design needs covered.
1214

@@ -170,31 +172,7 @@ Check out the full list and details in [`cssanimation-utilities.md`](./reference
170172

171173
### 🎉 That’s It!
172174

173-
## Accessibility: Respecting User Preferences
174-
175-
By default, **{css}animation** respects user system preferences. When `prefers-reduced-motion: reduce` is enabled in a user's operating system settings, animations are automatically turned off for a more comfortable user experience.
176-
177-
## License
178-
179-
**{css}animation** is licensed under the [Apache License, Version 2.0](https://github.com/yesiamrocks/cssanimation/blob/master/LICENSE).
180-
181-
## Contribute
182-
183-
We welcome issues, pull requests, and suggestions! 🤝 Help us make animations even more magical for everyone.
184-
185-
## Need Help?
186-
187-
If you’re building a **Website, Landing page, Tool, Visual Editor, or Framework** integration using **{css}animation**, feel free to reach out or contribute via GitHub Issues or Discussions.
188-
189-
## ☕ Support This Project
190-
191-
If you find **{css}animation** helpful, consider supporting my work. Your support helps me keep building open source tools, adding more animation packs, and writing design/dev insights in my newsletter [Pixels & Projects with Pavel](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/).
192-
193-
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?style=flat&logo=buy-me-a-coffee&logoColor=000000)](https://www.buymeacoffee.com/pavelrocks)
194-
195-
<br>
196-
197-
## AnimText
175+
## AnimText - Letter, Word & Line Text Animation JS Library
198176

199177
Add Smart Text Animations with [AnimText](https://github.com/yesiamrocks/animtext)
200178

@@ -210,9 +188,7 @@ Perfect for headlines, hero sections, callouts, and more.
210188

211189
👉 [Get Started with AnimText →](https://github.com/yesiamrocks/animtext)
212190

213-
<br>
214-
215-
## Triggle
191+
## Triggle - Simple Trigger-Based CSS Animation Control
216192

217193
Enhance Your **{css}animation** with Triggers
218194

@@ -225,9 +201,42 @@ Works beautifully with **{css}animation** out of the box. Use it to make your an
225201

226202
👉 [Get Started with Triggle →](https://github.com/yesiamrocks/triggle)
227203

228-
<br>
204+
## Accessibility: Respecting User Preferences
205+
206+
**{css}animation** is built with accessibility in mind. If a user has enabled `prefers-reduced-motion: reduce` in their system preferences, all animations are automatically disabled, ensuring a smoother and more comfortable experience for those sensitive to motion.
207+
208+
No extra configuration required. It's automatic, built-in, and developer-friendly.
209+
210+
## License
211+
212+
**{css}animation** {css}animation is proudly open-sourced under the [Apache License 2.0](./LICENSE). You can freely use it in personal, commercial, and creative projects.
213+
214+
Want a quick explanation? See the [License Summary →](./LICENSE-summary.md)
215+
216+
## Contribute
217+
218+
We welcome all contributions — whether it’s fixing bugs, adding animations, improving docs, or sharing ideas!
219+
220+
- Found an issue? [Open a GitHub Issue](https://github.com/yesiamrocks/cssanimation/issues)
221+
- Want to improve the library? [Submit a Pull Request](https://github.com/yesiamrocks/cssanimation/pulls)
222+
- Have questions or feature ideas? [Start a Discussion](https://github.com/yesiamrocks/cssanimation/discussions)
223+
224+
Help us make animations even more magical for everyone.
225+
226+
## Need Help?
227+
228+
**Using `{css}animation` in your project?**
229+
Whether it’s a website, landing page, tool, visual editor, or framework - we’d love to see it! Got feedback or ideas? Open a [GitHub Issue](https://github.com/yesiamrocks/cssanimation/issues) or join the [Discussions](https://github.com/yesiamrocks/cssanimation/discussions) to share.
230+
231+
## Support This Project
232+
233+
If you enjoy using **{css}animation** helpful, consider supporting my work.
234+
235+
please consider supporting its development. Your contribution helps maintain the library, expand animation packs, and publish design/dev tips through [Pixels & Projects with Pavel](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/).
236+
237+
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?style=flat&logo=buy-me-a-coffee&logoColor=000000)](https://www.buymeacoffee.com/pavelrocks)
229238

230-
## 💛 Become a Community Sponsor
239+
## Become a Community Sponsor
231240

232241
If you enjoy **{css}animation**, help support its development by becoming a monthly sponsor
233242

@@ -242,4 +251,4 @@ Help keep this open-source project alive and growing
242251

243252
<br>
244253

245-
![Built with ❤️ by Pavel](https://img.shields.io/badge/Built%20with-%E2%9D%A4%EF%B8%8F%20by%20Pavel-orange?style=for-the-badge) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?logo=linkedin&style=for-the-badge)](https://www.linkedin.com/in/shafayetul/) [![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20me%20a%20coffee-ffdd00?logo=buy-me-a-coffee&logoColor=000000&style=for-the-badge)](https://www.buymeacoffee.com/yesiamrocks)
254+
![Built with ❤️ by Pavel](https://img.shields.io/badge/Built%20with-%E2%9D%A4%EF%B8%8F%20by%20Pavel-orange?style=for-the-badge) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?logo=linkedin&style=for-the-badge)](https://www.linkedin.com/in/shafayetul/) [![Newsletter](https://img.shields.io/badge/Subscribe-Pixels%20&%20Projects%20-A6CA4B?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/newsletters/pixels-projects-with-pavel-7093275757006782464/)

0 commit comments

Comments
 (0)