From 52050338d65a9767c6a21d474b591b0a692a8f79 Mon Sep 17 00:00:00 2001
From: Pavel 'LEdoian' Turinsky <ledoian@matfyz.cz>
Date: Tue, 22 Nov 2022 19:45:39 +0100
Subject: [PATCH] More text in README

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fc37ebf..698bad2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,13 @@
 A simple tool for visualising OSPF network topology as seen by BIRD
 ====
 
-<!-- TODO: write more… -->
+This is a tool to visualize current state of the OSPF network and compare it to
+a reference / expected state.
+
+
+## Installation
+
+Run `pip install -e .`. You can use a virtualenv if you wish (recommended).
+
+A demo is located in `./poor_mans_visualisation.py`, if that runs, everything
+should be working.