Rename README to README.md
Since the CI will check mardkwon format files, the README files will
be updated to `.md` suffix.
Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I6175f53024559b41e05c2bd91d76548c889cb3ca
diff --git a/README b/README.md
similarity index 96%
rename from README
rename to README.md
index 29db34c..ec8c187 100644
--- a/README
+++ b/README.md
@@ -2,6 +2,7 @@
1. Single channel with one me and ipmb :
+```json
{
"channels": [
{
@@ -18,9 +19,11 @@
}
]
}
+```
2. Multiple sub channels with me and ipmb :
+```json
{
"channels": [
{
@@ -51,9 +54,11 @@
"remote-addr": 64,
"devIndex": 1
}
- ]
+ ]
}
+```
+```text
Config fields :
type : This points to the ChannelType. It can be ME or ipmb channel.
@@ -61,4 +66,4 @@
bmc-addr : This is BMC target address to communicate between BMC and device.
remote-addr : This is Remote/requester target address to communicate between BMC and device.
devIndex : This devIndex used to identify the particular device/host.
-
+```