From da606a6746902b297537a160d1cca677b0899b38 Mon Sep 17 00:00:00 2001
From: Farzad Ghanei <644113+farzadghanei@users.noreply.github.com>
Date: Sun, 12 May 2024 12:16:28 +0200
Subject: [PATCH] docs: update README.rst and chkok.spec

Update the description section in `chkok.spec` and format code blocks on
`README.rst`
---
 README.rst               | 18 +++++++++++-------
 build/package/chkok.spec |  7 ++++---
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/README.rst b/README.rst
index 3e9722c..76718a9 100644
--- a/README.rst
+++ b/README.rst
@@ -13,15 +13,19 @@ Usage
 
 Run in CLI mode (default):
 
-```
-chkok -conf examples/config.yaml
-```
+
+.. code-block:: shell
+
+    chkok -conf examples/config.yaml
+
 
 Run in HTTP mode, starting an HTTP server on the configured port:
 
-```
-chkok -conf examples/config.yaml -verbose -mode http
-```
+
+.. code-block:: shell
+
+    chkok -conf examples/config.yaml -verbose -mode http
+
 
 Configuration
 -------------
@@ -29,7 +33,7 @@ Configuration
 Configuration is done via a YAML file.
 
 `runners` section configures how the checks should be run. The runner configurations
-are merged with the `default`` runner configuration.
+are merged with the `default` runner configuration.
 
 .. code-block:: yaml
 
diff --git a/build/package/chkok.spec b/build/package/chkok.spec
index 35d6f06..36bfe0f 100644
--- a/build/package/chkok.spec
+++ b/build/package/chkok.spec
@@ -1,7 +1,7 @@
 Name: chkok
 Version: 0.3.0
 Release: 1%{?dist}
-Summary: Checks if system resources are OK
+Summary: checks files and sockets attributes
 
 License: MIT
 URL: https://github.com/farzadghanei/chkok
@@ -11,8 +11,9 @@ Source0: %{name}-%{version}.tar.gz
 # BuildRequires: golang > 1.22, golang-gopkg-yaml-3-devel > 3.0.0
 
 %description
-"chkok" checks if system resources are OK, and provides a report to demonstrate
-system health and resource availability.
+"chkok" checks if attributes of files and sockets match the provided conditions to ensure
+system state is as expected. It can be used to monitor system health and resource availability.
+Provides different running modes, useful for reporting to local and remote monitoring.
 
 # go toolchain stores go build id in a different ELF note than GNU toolchain
 # so RPM can't find the build id from the binaries after build.