Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
merwaaan committed Dec 15, 2024
1 parent 4354695 commit ecaeeed
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ bevy_spritesheet_animation is a [Bevy](https://bevyengine.org/) plugin for easil

![An animated character walking from the left to the right and shooting their gun](https://github.com/merwaaan/bevy_spritesheet_animation/raw/main/assets/example.gif)

> [!TIP]
> This crate supports the latest [Bevy 0.15](https://bevyengine.org/news/bevy-0-15/). Please check the [compatibility table](#compatibility) to see which version of this crate to use with older Bevy versions.
> [!NOTE]
> This crate is under active development. Please regularly check the [CHANGELOG](CHANGELOG.md) for recent changes.
# Features

- Animate 2D and [3D sprites](#3d-sprites)! 🎉
Expand All @@ -16,9 +22,6 @@ bevy_spritesheet_animation is a [Bevy](https://bevyengine.org/) plugin for easil
- [Events](https://docs.rs/bevy_spritesheet_animation/latest/bevy_spritesheet_animation/events/enum.AnimationEvent.html) to react to animations ending or reaching specific points.
- A [convenient API](https://docs.rs/bevy_spritesheet_animation/latest/bevy_spritesheet_animation/spritesheet/struct.Spritesheet.html) to select frames in spritesheets.

> [!TIP]
> This crate is under active development. Please regularly check the [CHANGELOG](CHANGELOG.md) for recent changes.
# Quick start

1. Add the [SpritesheetAnimationPlugin](https://docs.rs/bevy_spritesheet_animation/latest/bevy_spritesheet_animation/plugin/struct.SpritesheetAnimationPlugin.html) to your app
Expand Down

0 comments on commit ecaeeed

Please sign in to comment.