From bf5abef58189471d8fd3bf1f0bb32729789b9525 Mon Sep 17 00:00:00 2001 From: aceberg <1502200+aceberg@users.noreply.github.com> Date: Thu, 3 Aug 2023 12:20:44 +0700 Subject: [PATCH] README upd --- .github/workflows/main-docker-all.yml | 2 +- README.md | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/main-docker-all.yml b/.github/workflows/main-docker-all.yml index 38a41cb..426cc9e 100644 --- a/.github/workflows/main-docker-all.yml +++ b/.github/workflows/main-docker-all.yml @@ -1,4 +1,4 @@ -name: Docker +name: Main-Docker on: workflow_dispatch: diff --git a/README.md b/README.md index 59fdbf3..d32c3d5 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ ![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/aceberg/watchyourlan) ![Docker Pulls](https://img.shields.io/docker/pulls/aceberg/watchyourlan) -Lightweight network IP scanner with web GUI https://github.com/aceberg/WatchYourLAN - +Lightweight network IP scanner with web GUI - [Quick start](https://github.com/aceberg/WatchYourLAN#quick-start) - [Config](https://github.com/aceberg/WatchYourLAN#config) - [Config file](https://github.com/aceberg/WatchYourLAN#config-file) @@ -54,7 +53,7 @@ Configuration can be done through config file or environment variables ## Config file > [!WARNING] -> Config file format has been migrated to YAML in release v1.0.0. +> Config file format has been migrated to YAML in release [v1.0.0](https://github.com/aceberg/WatchYourLAN/releases/tag/1.0.0). Config file path is `/data/config.yaml`. All variables could be set there. Example: @@ -75,7 +74,7 @@ timeout: 120 | Key | Description | Default | | -------- | ----------- | ------- | -| -c | Path to config file | /data/config | +| -c | Path to config file | /data/config.yaml | | -n | Path to node modules (see below) | "" | ## Local network only