From 4dcce9214bdf452f966308d71ba8ab672786a69c Mon Sep 17 00:00:00 2001 From: Robert Prehn <3952444+prehnRA@users.noreply.github.com> Date: Sat, 20 Feb 2021 12:20:47 -0600 Subject: [PATCH] chore: Update README.md with basic usage instructions --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f8e64178..5595d59c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ # Legendary +# Up and Running + +In order to start the server, run `script/server`. Any dependencies required +will be installed automatically using [brew](https://brew.sh/), +[asdf](https://asdf-vm.com/#/), and [hex](https://hex.pm/). + +Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. + +# CI Configuration + +Legendary comes with gitlab CI settings which should work for you with minimal +setup. + +The CI script will automatically tag successful builds. To do this, you will +need to configure a [CI variable](-/settings/ci_cd) named `GITLAB_TOKEN`. This +token should be a [personal access token](/-/profile/personal_access_tokens) with +`read_repository, write_repository` permissions. + To start your Phoenix server: * Install dependencies with `mix deps.get` @@ -7,11 +25,7 @@ To start your Phoenix server: * Install Node.js dependencies with `npm install` inside the `assets` directory * Start Phoenix endpoint with `mix phx.server` -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 +# Learn more * Official website: https://www.phoenixframework.org/ * Guides: https://hexdocs.pm/phoenix/overview.html