diff --git a/README.md b/README.md new file mode 100644 index 0000000..8394e6d --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Aurinko + +Aurinko is a web UI for displaying data from solar panels that are using APsystems inverters. Currently +the only tested inverter model is QT2. + +**This project is heavily WIP.** diff --git a/backend/README.md b/backend/README.md deleted file mode 100644 index 6a2365c..0000000 --- a/backend/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# aurinko - -[![Package Version](https://img.shields.io/hexpm/v/aurinko)](https://hex.pm/packages/aurinko) -[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/aurinko/) - -```sh -gleam add aurinko -``` -```gleam -import aurinko - -pub fn main() { - // TODO: An example of the project in use -} -``` - -Further documentation can be found at . - -## Development - -```sh -gleam run # Run the project -gleam test # Run the tests -gleam shell # Run an Erlang shell -``` diff --git a/common/README.md b/common/README.md deleted file mode 100644 index 6b62b86..0000000 --- a/common/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# aurinko_common - -[![Package Version](https://img.shields.io/hexpm/v/aurinko_common)](https://hex.pm/packages/aurinko_common) -[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/aurinko_common/) - -```sh -gleam add aurinko_common -``` -```gleam -import aurinko_common - -pub fn main() { - // TODO: An example of the project in use -} -``` - -Further documentation can be found at . - -## Development - -```sh -gleam run # Run the project -gleam test # Run the tests -gleam shell # Run an Erlang shell -``` diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index 4edd159..0000000 --- a/frontend/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# frontend - -[![Package Version](https://img.shields.io/hexpm/v/frontend)](https://hex.pm/packages/frontend) -[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/frontend/) - -```sh -gleam add frontend -``` -```gleam -import frontend - -pub fn main() { - // TODO: An example of the project in use -} -``` - -Further documentation can be found at . - -## Development - -```sh -gleam run # Run the project -gleam test # Run the tests -gleam shell # Run an Erlang shell -```