summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4a186b9..bce45f8 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,19 @@
- [ebus-racket](ebus-racket/) eBus protocol parser written in racket
- [ebus-rust](ebus-rust/) eBus protocol parser writtin in rust
- [ebus-xml](ebus-xml/) eBus protocol specification (devices, packets, fields) in xml.
+
+## Usage of ebus-rust on nixos
+
+```
+ inputs.ebus.url = "github:yvesf/ebus";
+ inputs.ebus.inputs.nixpkgs.follows = "template/nixpkgs";
+ ...
+ # add module
+ ebus.nixosModules.ebus-rust
+ ...
+ # configure module
+ services.ebus-rust.enable = true;
+ services.ebus-rust.user = settings.username;
+ services.ebus-rust.device = "/dev/ttyUSB0";
+ ...
+``` \ No newline at end of file