From 9f77b79d944d0177279558468d2b9c86b6cfd7dd Mon Sep 17 00:00:00 2001
From: KW Kwan <kw.kwan@ribose.com>
Date: Mon, 4 Nov 2024 16:59:20 +0800
Subject: [PATCH] Update README of lutaml_klass_table and lutaml_ea_xmi for
 guidance

---
 README.adoc | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.adoc b/README.adoc
index 4f27e86..53dbec1 100644
--- a/README.adoc
+++ b/README.adoc
@@ -394,6 +394,29 @@ The command accepts the options listed below:
   `lib/metanorma/plugin/lutaml/templates`.  This template can be customized by
   changing the template path in the `template` option.
 
+* `guidance="/path/to/my_guidance.yml"`specifies the path of
+  the yaml file of the guidance. (Optional)
+
+The guidance file should be in the following format:
+
+[source,yaml]
+----
+---
+classes:
+  - name: Name Of Class
+    attributes:
+      - name: Name Of Attribute (e.g. gml:boundedBy)
+        used: false
+        guidance: |
+          Drop guidance message here.
+...
+----
+
+If you want to define the guidance, you can define the `name` of the class
+under `classes`.  Then define which `attributes` you want to add guidance by the
+`name`. Set `used` to show the attribute is used or not. Drop the message of
+guidance in `guidance`.
+
 === Generating UML class and attributes: `lutaml_uml_class`
 
 This command allows rendering a definition clause for a UML class.
@@ -853,6 +876,19 @@ By:
 ...
 -----
 
+You can define guidance in the configuration file as well. The configuration
+file will looks like:
+
+[source,yaml]
+-----
+packages:
+  - my_package
+guidance: "path/to/guidance.yaml"
+-----
+
+Please refer to `lutaml_klass_table` section for how to configure the guidance
+yaml file.
+
 == Documentation
 
 Please refer to https://www.metanorma.org.