basic readme

README.md

@@ -0,0 +1,22 @@
+# log-archiver
+
+[logs.tf](https://logs.tf) archiver
+
+## What
+
+Archives both the parsed json into a postgresql database and the raw log files
+into a folder.
+
+## Requirements
+
+Postgresql server with the schema from [`schema.sql`](./schema.sql) applied.
+
+## Usage
+
+Run the binary with the following environment variables
+
+- `DATABASE_URL`: connection url for the configured postgresql database, e.g.
+  `postgres://user:password@db_host/db_name`
+- `LOG_TARGET`: Folder to save the raw logs into
+- `API_HOST`: (Optional) overwrite the server to archive the logs from, defaults
+  to `https://logs.tf`