diff --git a/README.md b/README.md index 9ef2d02..2b0d8fc 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,20 @@ -# Checks that LÖVE is defined; if not, run in information loading +# Spritesheet -mode only. +Library for managing sprite sheets of textures and animations. + +Has support for both individual images in spritesheets and animations. This + can be specified from a lua file placed beside the spritesheet image file. + + ## Notes + +- When drawing an image or animation when a shader is defined the library may + send certain useful constants along, notably `spritesheet_inverse_width` and + `spritesheet_inverse_height`. +- Checks that LÖVE is defined; if not, run in information loading + mode only. ## Dependencies