summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Luha <rasmus.luha@ut.ee>2025-05-12 13:13:22 +0300
committerRasmus Luha <rasmus.luha@ut.ee>2025-05-12 13:13:22 +0300
commit6cb9f3eb1614f097992e27f2309bf6ca1cd37238 (patch)
treef4f2ca7739d98e10ed8dda201f2e088558ed9796 /README.md
parentaad1cf42f85eb1a2e2a34bf997a03f2941ec99de (diff)
update README.md, cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3ee758c..aa3f99c 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# Pipeline generator
-This is a pipeline generator that currently supports the following platforms: `Nifi`, `Telegraf`(TODO).
+This tool is a pipeline generator that currently supports the following platforms: `Nifi`, `Telegraf`.
+This was built as a part of my Bachelor's thesis.
## Usage
- `source venv/bin/activate`
- `pip install -r requirements.txt`
-- Setup sutff in `config.py` (database and nifi auth etc)
-- Then run `main.py`
-WIP
+- Setup sutff in `config.py`, for more info look at [Configuration info](#Configuration-info)
+- Then run `python main.py`
## Configuration info