diff --git a/README.md b/README.md index 2285821..28e96c0 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,10 @@ # SloaneSH -**TODO: Add description** +_Sloane's personal static site generator powering [sloane.sh](https://sloane.sh)._ -## Installation +## Setup -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `sloane_sh` to your list of dependencies in `mix.exs`: - -```elixir -def deps do - [ - {:sloane_sh, "~> 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 . +1. Clone the repo +2. Install Erlang and Elixir: `asdf install` +3. Install dependencies: `mix deps.get`