diff --git a/README.md b/README.md index 3fe209a..493d200 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # pdParticles -pdParticles is a free Playdate particle library created by [PossiblyAxolotl](https://www.youtube.com/PossiblyAxolotl). +[![Lua Version](https://img.shields.io/badge/Lua-5.4-yellowgreen)](https://lua.org) [![Toybox Compatible](https://img.shields.io/badge/toybox.py-compatible-brightgreen)](https://toyboxpy.io) [![Latest Version](https://img.shields.io/github/v/tag/PossiblyAxolotl/pdParticles)](https://github.com/PossiblyAxolotl/pdParticles/tags) + +pdParticles is a free Playdate particle library created by [PossiblyAxolotl](https://www.youtube.com/PossiblyAxolotl). ![playdate-20230131-144652](https://user-images.githubusercontent.com/76883695/215882419-0d358b40-1236-477b-a207-c5ba053922fd.gif) @@ -14,4 +16,21 @@ You can use pdParticles to draw circles, basic shapes, and custom sprites. Check out the [wiki](https://github.com/PossiblyAxolotl/pdParticles/wiki) to see how to get started and use the library. +#### Installing using toybox.py + +You can add it to your **Playdate** project by installing [**toybox.py**](https://toyboxpy.io), going to your project folder in a Terminal window and typing: + +```console +toybox add pdParticles +toybox update +``` + +Then, if your code is in the `source` folder, just import the following: + +```lua +import '../toyboxes/toyboxes.lua' +``` + +#### Donating + And if you're interested in donating to me you can do so on my [itch.io](https://possiblyaxolotl.itch.io/pdparticles).