aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8908dda
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Go Invaders
+A Space Invaders inspired game written in Go. Built with [Termloop](https://github.com/JoelOtter/termloop).
+
+## Installation
+```
+go install github.com/afagundes/go-invaders@latest
+$GOPATH/bin/go-invaders
+```
+
+## Controls
+Use the arrow keys to move the hero spaceship and space bar to shoot. Press backspace to quit.
+
+# Screenshots
+
+![Image of title screen](https://github.com/afagundes/go-invaders/blob/main/images/title_screen.png)
+
+![Image of game screen](https://github.com/afagundes/go-invaders/blob/main/images/running_game_screen.png)
+
+![Image of game over screen](https://github.com/afagundes/go-invaders/blob/main/images/game_over_screen.png)