From dbcdbaafebc08e3deedeffd340b6b2cad234f592 Mon Sep 17 00:00:00 2001
From: Andrea Cavalli <andrea@cavallium.it>
Date: Mon, 10 Oct 2022 01:18:31 +0200
Subject: [PATCH] Add readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a229bd5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# FileQueue
+Store messages on a disk queue in a fast producer, slow consumer scenario.
+
+```java
+var tmpFile = Paths.get("temp.queue.bin");
+try (var queue = new it.cavallium.filequeue.DiskQueueToConsumer<String>(tmpFile, new Serializer<String>() {
+  @Override
+  public byte[] serialize(String data) throws IOException {
+    return data.getBytes(StandardCharsets.US_ASCII);
+  }
+}, new Deserializer<String>() {
+  @Override
+  public String deserialize(byte[] data) throws IOException {
+    return new String(data, StandardCharsets.US_ASCII);
+  }
+}, text -> {
+  System.out.println("Received: %s", text);
+  
+  // Return true if the message has been consumed, false to retry later
+  return true;
+})) {
+  queue.startQueue();
+    
+  final var text = "test-message";
+	
+  while (true) {
+    System.out.println("Emitted: %s", text);
+    queue.add(text);
+  }
+}
+```
\ No newline at end of file