From 859985e3c34e450c47bb638e867144cd9cead4b4 Mon Sep 17 00:00:00 2001
From: rasmus <rasmus@k-space.ee>
Date: Sun, 6 Nov 2022 15:04:16 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5bda326
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# logmower-shipper
+
+Watches log directory for logs, and ships them to mongo.
+
+- Running: `go run .`
+- Building: `go build .`
+
+## Files
+1. `mower.go` acts as the main routine: initializes (including `mongo.go`) and watches for new files in log directory.
+2. `submit.go` watches file contents and tails them, streaming to `sender.go`.
+3. `sender.go` batches lines and ships them to mongo.