Add README
This commit is contained in:
parent
14556b226a
commit
17126d1b9c
2 changed files with 4 additions and 13 deletions
17
README.md
17
README.md
|
@ -1,18 +1,9 @@
|
||||||
# GeoTherminator
|
# GeoTherminator
|
||||||
|
|
||||||
To start your Phoenix server:
|
GeoTherminator allows you to see your Thermia ground heat pump's status at a single glance.
|
||||||
|
|
||||||
* Install dependencies with `mix deps.get`
|
<img src="demo.png" alt="Demo image" />
|
||||||
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
|
|
||||||
|
|
||||||
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
## Disclaimer
|
||||||
|
|
||||||
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
|
**Your pump is at risk!** Do not trust anyone with your account username and password. If you do not understand all the code contained in this software, do not use it. If you do not understand how to compile and deploy Elixir projects, do not use this.
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
BIN
demo.png
Normal file
BIN
demo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 110 KiB |
Loading…
Reference in a new issue