Update README
This commit is contained in:
parent
e2b7c0526e
commit
8aae3c1ca8
4 changed files with 6 additions and 75 deletions
6
README.md
Normal file
6
README.md
Normal file
|
@ -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.**
|
|
@ -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 <https://hexdocs.pm/aurinko>.
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
```sh
|
|
||||||
gleam run # Run the project
|
|
||||||
gleam test # Run the tests
|
|
||||||
gleam shell # Run an Erlang shell
|
|
||||||
```
|
|
|
@ -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 <https://hexdocs.pm/aurinko_common>.
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
```sh
|
|
||||||
gleam run # Run the project
|
|
||||||
gleam test # Run the tests
|
|
||||||
gleam shell # Run an Erlang shell
|
|
||||||
```
|
|
|
@ -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 <https://hexdocs.pm/frontend>.
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
```sh
|
|
||||||
gleam run # Run the project
|
|
||||||
gleam test # Run the tests
|
|
||||||
gleam shell # Run an Erlang shell
|
|
||||||
```
|
|
Loading…
Reference in a new issue