From 1919efbe0c565e3fc4a74d5a075df0456effaa06 Mon Sep 17 00:00:00 2001
From: Leonard Kugis <leonard@kug.is>
Date: Mon, 22 Jul 2024 04:15:57 +0200
Subject: Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6848c30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# YARA compiler
+
+This compiler takes YARA rules in JSON format and compiles it into binary YAC files.
+They are simpler to handle in external and embedded applications.
+
+## Usage
+
+```
+usage: yara-compiler.py [-h] [-i [INPUT_DIRECTORY]] [-o [OUTPUT]] [-f [INPUT_FILE]] [-v]
+
+Compile single or multiple yara files
+
+options:
+  -h, --help            show this help message and exit
+  -i [INPUT_DIRECTORY], --input-directory [INPUT_DIRECTORY]
+                        Input directory (default: .)
+  -o [OUTPUT], --output [OUTPUT]
+                        Output file or directory (default: .)
+  -f [INPUT_FILE], --input-file [INPUT_FILE]
+                        Input file (default: .)
+  -v, --verbose         Verbosity level
+```
\ No newline at end of file
-- 
cgit v1.2.1