add readme

knaw-huc · Jan 27, 2025 · fb48d2c · fb48d2c
1 parent 455e05d
commit fb48d2c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Occassio Browser
+
+This repository contains an elasticsearch based browser for searching through UsenetNews archives. The import script populates an elasticsearch index with files found in the `import/data` directory (expected to be in zip archives). The browser and service together form the front- and backend of the search browser.