From 321d89e2986515b51d310853d02b8ba430e3e46b Mon Sep 17 00:00:00 2001 From: Shunichiro Aki Date: Mon, 27 Jan 2025 07:33:25 +0900 Subject: [PATCH] feat: update document --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c43f6fc..d3c33a9 100644 --- a/README.md +++ b/README.md @@ -26,25 +26,18 @@ ECHONET Liteプロトコルを使用して、Wi-SUN対応スマートメータ 必要な環境変数については[こちら](https://github.com/nana4rider/wisun2mqtt/blob/main/src/env.ts)をご確認ください。 -### Production +### Native ```sh npm install npm run build -node dist/index -``` - -### Development - -```sh -npm install -npm run dev +node --env-file=.env dist/index ``` ### Docker ```sh -# PAN情報をホスト側に配置するとスキャンを省略し、次回からの接続が早くなります。 +# .paninfo をホスト側に配置するとスキャン結果がコンテナ再起動後も残るため、次回からの接続が早くなります。 touch .paninfo docker run -d \ @@ -52,8 +45,11 @@ docker run -d \ --device /dev/ttyUSB0:/dev/ttyUSB0 \ -v /dev/ttyUSB0:/dev/ttyUSB0 \ -v $(pwd)/.paninfo.json:/app/.paninfo.json \ - -p 3000:3000 \ --env-file .env \ + -p 3000:3000 \ --restart always \ nana4rider/wisun2mqtt:latest ``` + +> [!TIP] +> 必要な環境変数については[こちら](src/env.ts)をご確認ください。