Readme update: Supported messages and known working products.
authorJosh Stompro <stomproj@larl.org>
Thu, 11 May 2023 14:53:39 +0000 (09:53 -0500)
committerJosh Stompro <stomproj@larl.org>
Thu, 11 May 2023 15:04:39 +0000 (10:04 -0500)
Added a list of supported messages from the NCIP core message set.

Added a note about SHAREit being the currently known supported product.

Signed-off-by: Josh Stompro <stomproj@larl.org>
README.adoc

index 5115726..3ca2342 100644 (file)
@@ -418,3 +418,30 @@ will need to change that entry to whatever your vendor uses.  You can
 more Allow from or Require ip entries for other vendors and/or
 hosts. It is also a good idea to allow of your own ips to connect for
 testing purposes.
+
+Supported NCIP V2 Messages
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+https://www.niso.org/standards-committees/ncip/ncip-core-message-set[
+Messages in the NCIP V2 Core Message Set.]
+
+.NCIP V2 Messages Supported
+[options="header",cols="1,1,3"]
+|===========================
+| Message             | Support | Notes
+| Accept Item         | *Yes*   |
+| Cancel Request Item | *Yes*   |
+| Check In Item       | *Yes*   |
+| Check Out Item      | *Yes*   |
+| Lookup Item         | No      |
+| Lookup User         | *Yes*   | Does not suppport checking password or PIN.
+| Recall Item         | No      |
+| Renew Item          | *Yes*   |
+| Request Item        | *Yes*   |
+|===========================
+
+Supported Products
+~~~~~~~~~~~~~~~~~~
+
+Codebase is only known to work with https://www.auto-graphics.com/share-it/[
+Auto-Graphics' SHAREit ILL System].