basic readme

README.md

@@ -0,0 +1,21 @@
+# log-normalizer
+
+Perform some normalization on the parsed logs from [logs.tf](https://logs.tf/)
+
+This works on the archived data as created by the
+[log-archiver](https://codeberg.org/icewind/log-archiver).
+
+## Requirements
+
+- Postgresql database with the schema from [`schema.sql`](./schema.sql) applied.
+- Postgresql database with the schema from
+  [log-archiver](https://codeberg.org/icewind/log-archiver) applied.
+
+## Usage
+
+Run the binary with the following environment variables
+
+- `DATABASE_URL`: connection url for database that the normalized data will be
+  stored, e.g. `postgres://user:password@db_host/normalized_logs`
+- `RAW_DATABASE_URL`: connection url for database that the raw log data is
+  stored in, e.g. `postgres://user:password@db_host/raw_logs`