aboutsummaryrefslogtreecommitdiff
path: root/src/stream/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/stream/README')
-rw-r--r--src/stream/README12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/stream/README b/src/stream/README
index 9b550b0..977ca2d 100644
--- a/src/stream/README
+++ b/src/stream/README
@@ -1,11 +1,11 @@
-The aim of the stream library is to provide stream connections between peers in
-GNUnet. This is a convenience library which hides the complexity of dividing
-data stream into packets, transmitting them and retransmitting them in case of
+Stream library provides stream connections between peers in GNUnet. This is a
+convenience library which hides the complexity of dividing data stream into
+packets, transmitting them and retransmitting them in case of communication
errors.
This library's API are similar to unix PIPE API. The user is expected to open a
stream to a listening target peer. Once the stream is established, the user can
-use it as a pipe. Any data written into the stream will be readable by the
-target peer.
+use it as a pipe. Any data written into the stream at one peer will be readable
+by the other peer and vice versa.
-This library uses mesh API for establishing streams between peers. \ No newline at end of file
+This library uses mesh API for establishing tunnels between peers. \ No newline at end of file