Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
koarlchen committed Sep 12, 2024
1 parent ff4684c commit 226a3eb
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ The document itself is provided as a template to which the latest sensor values
The sensor values are collected from an InfluxDB that will be continiously updated from HomeAssistant.


## Endpoints

- GET `/status.json`: Request the current space status compliant to the Space API JSON schema.
- GET `/health`: Get health information, basically checks the connection to the database. Returns 200 if everything is ok, and 418 in case the connection could not be established.


## Configuration

The configuration takes place within the file `config.json`:
Expand Down Expand Up @@ -62,6 +68,8 @@ The template for the Space API JSON document is defined within the file `status.

Building the software requires a Rust toolchain to be installed.
If so, the build process is as easy as `cargo build [--release]`.
Currently, the build defaults to x64 with musl on Linux (see `.cargo/config.toml`).
You may override it by providing the necessary arguments to cargo.

Two minimalistic tests are provided to check wether the configuration and the tempalte files can be parsed.
Run `cargo test` to execute the tests.
Two minimalistic tests are provided to check wether the configuration and the template files can be parsed.
Run `cargo test` to execute the tests.

0 comments on commit 226a3eb

Please sign in to comment.