From 047ac73788940256cc863ac55c1271c2fc54b75b Mon Sep 17 00:00:00 2001
From: mivirl <>
Date: Tue, 3 Oct 2023 20:15:51 -0500
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4928fa5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Minimum Viable Remote Logging
+
+This project is an attempt to make a logging solution for simple use cases. The
+simplicity is primarily from the maintainer's standpoint, rather than using
+the most efficient code.
+
+This script can do the following:
+- Retrieve basic information
+- Monitor processes
+- Copy files
+- Tail logs
+
+The primary reason for creating this is to monitor a machine for activity from
+naive malware or attackers, although it is likely better suited for cases
+without active interference.
+
+All needed binaries are static so dependencies don't need to be installed on
+the remote system.
+
+
+## Building
+
+Use the included build script to retrieve and build direct dependencies:
+
+```sh
+./build.sh
+```
+
+## Deploying
+
+### Server
+To deploy on the server, you'll need to do transfer the `build/output/server`
+directory to the remote system, then `cd` to that directory and run:
+
+```sh
+./busybox sh start_server.sh
+```
+
+### Client
+
+To deploy on the client, you'll need to do transfer the `build/output/client`
+directory to the remote system, then `cd` to that directory and run:
+
+```sh
+./smallperl.bin client.pl
+```
-- 
2.39.5