Skip to content

📝 Add run instructions to README #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2023
Merged

📝 Add run instructions to README #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ce858a
:pencil2: Fix a typo in the README
penguineer Apr 16, 2023
3cb75b7
:memo: Add run instructions
penguineer Apr 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ The following environment variables are expected:

In the above example, anything listed as `<...>` is meant to be replaced by a value described by the label with the brackets, e.g. `<chip name>` is written as `coretemp-isa-0000` without the brackets.

## Running

With the configuration stored in a file `.env`, the tool can be started as follows:

```bash
docker run --rm \
--env-file .env \
mrtux/sensors-report
```

Alternatively there is a `docker-compose` set up to build and run from the repository.

For production use pre-built docker images are recommended.

## Contributions

Contributions are welcome and should be made via PR.
Expand All @@ -33,4 +47,4 @@ monitoring system might be more appropriate.

## License

This project is published unter the MIT license.
This project is published under the MIT license.