From e4c68ef1a773591f792848b060af8b3db12ebbea Mon Sep 17 00:00:00 2001 From: Sebastian Garcia Date: Wed, 24 Jul 2024 22:38:09 +0200 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2ede00f..d9b24e2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,28 @@ -# Awesome Code Template +# Zeek-term + +Zeek-term is a python program that reads several Zeek log files (conn.log, http.log, files.log, ssl.log, quick.log, dns.log, ntp.log) and prints all the lines sorted by time. It also adds colors so it is easier to analyze. -This repository is a template with basic elements that every repository at Stratosphere should follow. ## Features -Write about what makes your [tool|code|data|repo] special. +- Sorted logs from all the Zeek files. +- Adds background color. +- Adds foreground color. +- Adds a column with the name of the file that each log cames from. ## Usage -Write about how others can use your [tool|code|data|repo]. +```python +python zeek-term.py --foreground --directory . |less -RS +``` + +- `--foreground` is to use foreground colors instead of background +- `--directory` is to set where the Zeek logs are + +# How it looks like +image + # About -This [tool|code|data|repo] was developed at the Stratosphere Laboratory at the Czech Technical University in Prague. +This tool was developed at the Stratosphere Laboratory at the Czech Technical University in Prague by Sebastian Garcia, sebastian.garcia@agents.fel.cvut.cz