aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..356ab49
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+# rsvr -- a in-memory file reservoir
+
+rsvr is a small helper utility that receives data from non-seekable
+sources on `stdin` such as a pipe or a socket, placing it into a in-memory
+file resorvoir (it also can read from regular, seekable files). When the
+source is closed (or end-of-file is reached) the subsequent command is
+executed.
+
+There are no options to set. Usage is as simple as
+
+ rsvr <subsequent command with argument>
+
+With the source data being read from `stdin`.
+
+# Example
+
+ # download a PDF from the web and show it using MuPDF
+ curl <some URL> | rsvr mupdf /dev/stdin