[#133]: Update README

Author: JacobDomagala

.github/workflows/linter.yml

@@ -32,5 +32,5 @@ jobs:
           use-mypy: true
           use-isort: false
           extra-mypy-options: "--ignore-missing-imports --show-error-codes"
-          extra-flake8-options: "--max-line-length=120 --ignore=E203,E402"
-          extra-pycodestyle-options: "--max-line-length=120 --ignore=E203,E402"
+          extra-flake8-options: "--max-line-length=120 --ignore=E203,E402,W503"
+          extra-pycodestyle-options: "--max-line-length=120 --ignore=E203,E402,W503"

README.md

@@ -146,6 +146,8 @@ jobs:
 | `use_cmake`             | Determines wether CMake should be used to generate compile_commands.json file | `true` |
 | `cmake_args`            | Additional CMake arguments |`<empty>`|
 | `force_console_print`   | Output the action result to console, instead of creating the comment |`false`|
+| `compile_commands`   | User generated compile_commands.json |`<empty>`|
+| `compile_commands_replace_prefix`   | Whether we should replace the prefix of files inside user generated compile_commands.json file |`false`|
 
 **NOTE: `apt_pckgs` will run before `init_script`, just in case you need some packages installed before running the script**
 

action.yml

@@ -25,7 +25,7 @@ inputs:
   apt_pckgs:
     description: 'Additional (space separated) packages that need to be installed in order for project to compile'
   compile_commands:
-    description: 'user generated compile_commands.json'
+    description: 'User generated compile_commands.json'
   compile_commands_replace_prefix:
     description: 'Whether we should replace the prefix of files inside user generated compile_commands.json file'
     default: false