From 4bf204891e27170587ad173d29a2c8c083d51f38 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Wed, 8 Jan 2025 13:37:03 +0100
Subject: [PATCH] DOC: update README

---
 .gitignore | 1 +
 README.md  | 7 +++++++
 2 files changed, 8 insertions(+)

diff --git a/.gitignore b/.gitignore
index 658f3bc..d23d60e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,6 +13,7 @@ venv
 
 # configurations
 qualitycheck_config.toml
+pylinkahead.ini
 
 # build artifacts
 *.egg-info
diff --git a/README.md b/README.md
index 0e450f7..f1edc18 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,13 @@ the data, stores the results in a [LinkAhead](https://getlinkahead.com) instance
 
 ## Usage
 
+### Virtual Environment (Optional)
+
+Before installing create a virtual environment:
+
+* `python -m venv .venv`
+* `source .venv/bin/activate`
+
 ### Installation ###
 
 Simply install with:
-- 
GitLab