From 6ff5a269b19d0e59a5327070aabd56e59b412f48 Mon Sep 17 00:00:00 2001
From: Nicola Coretti <nicola.coretti@exasol.com>
Date: Wed, 9 Aug 2023 13:02:02 +0200
Subject: [PATCH] Update README.md

---
 README.md | 43 ++++++++++++++++++++++++++++++++++---------
 1 file changed, 34 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index cf7f1d0..57cd3d6 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
 # Error Reporting Python
 
-This project contains a python library for describing Exasol error messages. 
-This library lets you define errors with a uniform set of attributes. 
-Furthermore, the error message  is implemented to be parseable, 
+This project contains a python library for describing Exasol error messages.
+This library lets you define errors with a uniform set of attributes.
+Furthermore, the error message is implemented to be parseable,
 so that you can extract an error catalog from the code.
 
-
 ## In a Nutshell
+
 Create an error object:
 
 ```python
-exa_error_obj = ExaError.message_builder('E-TEST-1')\
-    .message("Not enough space on device {{device}}.")\
-    .mitigation("Delete something from {{device}}.")\
-    .mitigation("Create larger partition.")\
+exa_error_obj = ExaError.message_builder('E-TEST-1')
+    .message("Not enough space on device {{device}}.")
+    .mitigation("Delete something from {{device}}.")
+    .mitigation("Create larger partition.")
     .parameter("device", "/dev/sda1", "name of the device") 
 ```
 
@@ -24,15 +24,40 @@ print(exa_error_obj)
 ```
 
 Result:
+
 ```
 E-TEST-1: Not enough space on device '/dev/sda1'. Known mitigations:
 * Delete something from '/dev/sda1'.
 * Create larger partition.
 ```
 
-
 Check out the [user guide](doc/user_guide/user_guide.md) for more details.
 
+## Tooling
+
+The `error-reporting-python` library comes with a command line tool (`ec`) which also can be invoked
+by using its package/module entry point (`python -m exasol.error`).
+For detailed information about the usage consider consulting the help `ec --help` or `python -m exasol.error --help`.
+
+### Parsing the error definitions in a python file(s)
+
+```shell
+ec parse some-python-file.py 
+```
+
+```shell
+ec parse < some-python-file.py 
+```
+
+## Generating an error-code data file
+
+In order to generate a [error-code-report](https://schemas.exasol.com/error_code_report-1.0.0.json) compliant data file,
+you can use the generate subcommand.
+
+```shell
+ec generate NAME VERSION PACKAGE_ROOT > error-codes.json
+```
+
 ### Information for Users
 
 * [User Guide](doc/user_guide/user_guide.md)