From 269fd1c1071c3da3347eab99b763a0a8546c4c7d Mon Sep 17 00:00:00 2001 From: Christian Kellner Date: Mon, 20 Jul 2020 16:23:47 +0200 Subject: [PATCH] improving docu --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41a2e8d..93d15f6 100755 --- a/README.md +++ b/README.md @@ -152,9 +152,11 @@ Districts that are unwanted can be blacklisted here. This makes sense for provider that only offer limited filter functions like Kalaydo/Ebay. # API -While Fredy is running, you can make use of the rest api provided on port `9998` to get information about the current status of Fredy. +While Fredy is running, you can make use of the rest api provided on port `9998` to get information about the current status of Fredy. +You can disable the api by setting `infoApi: false` within the config. + #### http://localhost:9998/ -Gives you an overview of running search jobs, their included enabled provider, last execution and the number of listings, found by each provider. You can disable the api by setting `infoApi: false` within the config. +Gives you an overview of running search jobs, their included enabled provider, last execution and the number of listings, found by each provider. #### http://localhost:9998/ping Should you ever need some health checks, this returns pong ;)