sloanelybutsurely/sloane.sh
1
0
Fork 0
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
sloane 2024-02-16 16:11:13 -05:00
parent 319fa4b881
commit d4e3f73881
1 changed files with 5 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -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 <https://hexdocs.pm/sloane_sh>.
1. Clone the repo
2. Install Erlang and Elixir: `asdf install`
3. Install dependencies: `mix deps.get`