Browse Source

Update readme with basic description and installation info

master
Julian Noble 2 years ago
parent
commit
3e7ffc7be9
  1. 9
      README.md

9
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 <https://hexdocs.pm/tetris>.

Loading…
Cancel
Save