From 029545ba1fbd36a28b84ceeb1d2fefc9cf0f76e3 Mon Sep 17 00:00:00 2001
From: Dmitry Simonenko <pmwkaa@gmail.com>
Date: Thu, 8 Jun 2017 16:17:16 +0300
Subject: [PATCH] shapito: update README.md

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 2917261e..985b935d 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,53 @@
-shapito
---------
+**shapito*
 
 PostgreSQL protocol-level client C library.
 
-**API REFERENCE*
+**API REFERENCE**
 
 **PostgreSQL packet validators**
 
 ```C
+/* Validate StartupMessage, CancelRequest or SSLRequest */
 so_read_startup()
+
+/* Validate any other PostgreSQL packet */
 so_read()
 ```
 
 **Frontend to Backend messages**
 
 ```C
+/* StartupMessage */
 so_fewrite_startup_message()
+
+/* CancelRequest */
 so_fewrite_cancel()
+
+/* SSLRequest */
 so_fewrite_ssl_request()
+
+/* Terminate */
 so_fewrite_terminate()
+
+/* PasswordMessage */
 so_fewrite_password()
+
+/* Query */
 so_fewrite_query()
+
+/* Parse */
 so_fewrite_parse()
+
+/* Bind */
 so_fewrite_bind()
+
+/* Describe */
 so_fewrite_describe();
+
+/* Execute */
 so_fewrite_execute();
+
+/* Sync */
 so_fewrite_sync();
 ```
 
@@ -38,21 +61,48 @@ so_feread_parameter();
 **Backend to Frontend messages**
 
 ```C
+/* ErrorResponse */
 so_bewrite_error()
 so_bewrite_error_fatal()
 so_bewrite_error_panic()
+
+/* NoticeResponse */
 so_bewrite_notice()
+
+/* AuthenticationOk */
 so_bewrite_authentication_ok()
+
+/* AuthenticationCleartextPassword */
 so_bewrite_authentication_clear_text()
+
+/* AuthenticationMD5Password */
 so_bewrite_authentication_md5()
+
+/* BackendKeyData */
 so_bewrite_backend_key_data()
+
+/* ParameterStatus */
 so_bewrite_parameter_status()
+
+/* EmptyQueryResponse */
 so_bewrite_empty_query()
+
+/* CommandComplete */
 so_bewrite_complete()
+
+/* ReadyForQuery */
 so_bewrite_ready()
+
+/* ParseComplete */
 so_bewrite_parse_complete()
+
+/* BindComplete */
 so_bewrite_bind_complete()
+
+/* PortalSuspended */
 so_bewrite_portal_suspended()
+
+/* NoData */
 so_bewrite_no_data()
 ```