diff --git a/README.md b/README.md index 10c59fc..a2fbafc 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,13 @@ -# asteroids +# Asteroids -TODO: Write a description here +A simple implementation of the classic asteroids game written in Crystal using SDL2 -## Installation +![screenshot](screenshot-1.gif) -TODO: Write installation instructions here +## Building -## Usage - -TODO: Write usage instructions here - -## Development - -TODO: Write development instructions here +- Install SDL2 +- run `shards build` ## Contributing diff --git a/screenshot-1.gif b/screenshot-1.gif new file mode 100644 index 0000000..6172e71 Binary files /dev/null and b/screenshot-1.gif differ diff --git a/shard.yml b/shard.yml index e241a78..9f30ea7 100644 --- a/shard.yml +++ b/shard.yml @@ -15,4 +15,4 @@ license: MIT dependencies: pixelfaucet: github: SleepingInsomniac/pixelfaucet - # version: 0.0.1 + version: 0.0.1