Skip to content

Commit

Permalink
docs: update README.rst and chkok.spec
Browse files Browse the repository at this point in the history
Update the description section in `chkok.spec` and format code blocks on
`README.rst`
  • Loading branch information
farzadghanei committed May 12, 2024
1 parent ced45b2 commit da606a6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
18 changes: 11 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,27 @@ 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
-------------

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
Expand Down
7 changes: 4 additions & 3 deletions build/package/chkok.spec
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down

0 comments on commit da606a6

Please sign in to comment.