Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mahmoudhtayem87 committed May 11, 2022
1 parent b7bc6c1 commit a8c88a6
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Liferay Animation

This project has been created with [generator-liferay-fragments][1]. You can read
how to manage this project in the [generator documentation][2].
This project has been created to showcase embedding css animation framework in liferay using simple fragments.
The project contains a fragment collection which has 3 main fragments:
- **Animation Resources**: You will need to use this fragment at the top of your master page or the page you would like to introduce animation in it; this fragment adds the required **JS** and **CSS** references.
- **Animation Page End Script**: You will need to use this fragment at the bottom of your master page or the page you would like to introduce animation in it; this fragment contains a JavaScript to refresh the animation after page load to insure that the animation is working fine.
- **Animation Container**: You will need to use this fragment as a container of liferay element (widget/fragment) which you would like to apply the animation on it.

[1]: https://www.npmjs.com/package/generator-liferay-fragments
[2]: https://www.npmjs.com/package/generator-liferay-fragments#usage
###Note!
_Please note that the required **JS** and **CSS** has been added to the collection resources_

0 comments on commit a8c88a6

Please sign in to comment.