diff options
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
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 |