From 3e7ffc7be95e3206ee740e4f0f13d49fc44a184b Mon Sep 17 00:00:00 2001 From: Julian Noble Date: Mon, 12 Sep 2022 02:24:17 +1000 Subject: [PATCH] Update readme with basic description and installation info --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 29a0de9..dd2881e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,18 @@ # Tetris -**TODO: Add description** +## Description +Basic Tetris game written in Elixir using Phoenix Liveview - from groxio tutorial ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `tetris` to your list of dependencies in `mix.exs`: ```elixir def deps do [ - {:tetris, "~> 0.1.0"} + {:tetris, git: "https://gitea1.intx.com.au/jn/tetris.git", tag: "0.1.0"} ] end ``` Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at .