diff --git a/README.md b/README.md index 62344a2..771ed8c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,10 @@ # Groupdle -To start your Phoenix server: +A competitive Wordle-inspired online party game - * Run `mix setup` to install and setup dependencies - * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server` +## Setup -Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. - -Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html). - -## Learn more - - * Official website: https://www.phoenixframework.org/ - * Guides: https://hexdocs.pm/phoenix/overview.html - * Docs: https://hexdocs.pm/phoenix - * Forum: https://elixirforum.com/c/phoenix-forum - * Source: https://github.com/phoenixframework/phoenix +1. Install [mise](https://mise.jdx.dev/) +2. Install tools: `mise install` +3. Install dependencies: `mix deps.get` +4. Start development server: `iex -S mix phx.server`