From e1b8fbf280f3eb921b0b42fbf96fc3d0346c93c0 Mon Sep 17 00:00:00 2001 From: "Alexander \"Arav\" Andreev" Date: Sun, 2 Jan 2022 21:56:53 +0400 Subject: [PATCH] Updated README. --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0236757..201696a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -# httpprocwatchd Ver 1.3 +# httpprocwatchd Ver 1.3.2 License: MIT+NIGGER. This utility provides a HTTP `/processes` GET endpoint that returns a list of -processes and if they are currently running or not. +processes, and if they are currently running or not. -A list of processes could be in JSON or XML format, By default JSON being returned. -To get XML you need to provide a `Accept: application/xml` header in GET reqest. +There are currently three output formats available: JSON, XML, plain text. -A JSON object looks like this: `{ "process": true|false, ... }`. +JSON is a default format if `Accept` header didn't provided, or did do with +value `application/json`. Its form is `{"process":true|false, ...}`. -And XML `true|false...`. +XML is provided if `Accept: application/xml` header was given. Its form is +`true|false...`. +Plain text is provided if `Accept: text/plain` header was given. Its form is a +comma separated list of ONLY running process' names. -Configuration file is a simple JSON object consisting of `listen_address` string field -in form `"[]:"`. And `processes` array of process names. \ No newline at end of file +Configuration file is a simple key = value storage consisting of `listen_address` string +field in form `"[]:"`. `indented_output` bool in form `true|false`, to +enable indentation of JSON and XML output. And `processes` is a space separated array +of process names. \ No newline at end of file