X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=b2389d91b13708ec6b73d4a0c07d97123207e3a5;hb=ed10b5afc2b65437a635a6db224f2c3d1a837479;hp=9d557b861f2b44b77ff6d0c3546e1963184137ea;hpb=b7f680ac37b139d02f109cfff9ad9344a8415aad;p=kconfig-hardened-check.git

diff --git a/README.md b/README.md
index 9d557b8..b2389d9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 # kconfig-hardened-check
 
+![functional test](https://github.com/a13xp0p0v/kconfig-hardened-check/workflows/functional%20test/badge.svg)
+[![Coverage Status](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check/graph/badge.svg)](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check)
+
 ## Motivation
 
 There are plenty of Linux kernel hardening config options. A lot of them are
@@ -26,12 +29,20 @@ or exploitation techniques.
   - ARM64
   - ARM
 
-## Output examples
+## Installation
+
+You can install the package:
+
+```
+pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check
+```
+
+or simply run `./bin/kconfig-hardened-check` from the cloned repository.
 
-### Usage
+## Usage
 ```
-usage: kconfig-hardened-check.py [-h] [-p {X86_64,X86_32,ARM64,ARM}]
-                                 [-c CONFIG] [--debug] [--json]
+usage: kconfig-hardened-check [-h] [-p {X86_64,X86_32,ARM64,ARM}] [-c CONFIG]
+                              [--debug] [--json]
 
 Checks the hardening options in the Linux kernel config
 
@@ -45,15 +56,15 @@ optional arguments:
   --json                print results in JSON format
 ```
 
-### Output for `Ubuntu 18.04 (Bionic Beaver with HWE)` kernel config
+## Output for `Ubuntu 18.04 (Bionic Beaver with HWE)` kernel config
 ```
-$ ./kconfig-hardened-check.py -c config_files/distros/ubuntu-bionic-generic.config
-[+] Trying to detect architecture in "config_files/distros/ubuntu-bionic-generic.config"...
+$ ./bin/kconfig-hardened-check -c kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config 
+[+] Trying to detect architecture in "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config"...
 [+] Detected architecture: X86_64
-[+] Trying to detect kernel version in "config_files/distros/ubuntu-bionic-generic.config"...
+[+] Trying to detect kernel version in "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config"...
 [+] Found version line: "# Linux/x86 5.3.0-28-generic Kernel Configuration"
 [+] Detected kernel version: 5.3
-[+] Checking "config_files/distros/ubuntu-bionic-generic.config" against X86_64 hardening preferences...
+[+] Checking "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config" against X86_64 hardening preferences...
 =========================================================================================================================
                  option name                 | desired val | decision |       reason       |   check result
 =========================================================================================================================