summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimo Dritschler <timo.dritschler@kit.edu>2015-04-21 14:30:36 +0200
committerTimo Dritschler <timo.dritschler@kit.edu>2015-04-21 14:30:36 +0200
commit9ea244a2a7a52495bf033dd9f1cca7c865baf200 (patch)
tree0b59ce64eff56e202e8777ce7ea9ae1590af38c8
parent856acb00efec21bc22e9f62cbb5a1d99e0ad9e96 (diff)
downloadkiro-9ea244a2a7a52495bf033dd9f1cca7c865baf200.tar.gz
kiro-9ea244a2a7a52495bf033dd9f1cca7c865baf200.tar.bz2
kiro-9ea244a2a7a52495bf033dd9f1cca7c865baf200.tar.xz
kiro-9ea244a2a7a52495bf033dd9f1cca7c865baf200.zip
Updated README to mention KiroSb as well
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4cb06a9..7704385 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,8 @@ KIRO is the KITs InfiniBand remote communication library.
It provides a simple server and client class that can be used to pass arbitrary
information from the server to the client using _native_ InfiniBand
communication.
-It also provides a network transmittable ring-buffer (TRB) which can be used as
-a transmission container for same-sized objects.
+It also provides a network transmittable ring-buffer (KIRO-TRB) which can be used as
+a transmission container for same-sized objects and a (uni directional) self-synchronizing buffer (KIRO-SB) which can be used to automatically keep a local object in sync with a shared remote object.
The library is optimized for speed and ease of use.
@@ -22,7 +22,7 @@ Usage
Example KIRO server usage
-```
+```C
#include <kiro-server.h>
...
@@ -45,7 +45,7 @@ kiro_server_free (server);
```
Example KIRO client usage
-```
+```C
#include <kiro-client.h>
...