From 100b66d60bed1c67c07bc79faf0ae130461ede81 Mon Sep 17 00:00:00 2001
From: mfarragher <33595938+mfarragher@users.noreply.github.com>
Date: Tue, 19 Oct 2021 22:54:17 +0100
Subject: [PATCH] Update readme and requirements

---
 README.md        | 20 +++++++++++++-------
 requirements.txt |  1 +
 setup.py         |  3 ++-
 3 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 9ee8f4e..b23c4e3 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,7 @@ This is how **`obsidiantools`** can complement your workflows for note-taking:
 - **Retrieve detail about your notes' links and metadata as built-in Python types**
     - The various types of links:
         - Wikilinks (incl. header links, links with alt text)
+        - Embedded files
         - Backlinks
         - Markdown links
     - You can access all the links in one place, or you can load them for an individual note:
@@ -51,13 +52,18 @@ Developed for Python 3.9 but may still work on lower versions.
 As of Sep 2021, NetworkX requires Python 3.7 or higher (similar for Pandas too) so that is recommended as a minimum.
 
 ## 🖇️ Dependencies
-- markdown
-- html2text
-- pandas
-- numpy
-- networkx
-- python-frontmatter
-- beautifulsoup4
+- Main libraries:
+    - markdown
+    - html2text
+    - pandas
+    - numpy
+    - networkx
+- Libraries for parsing front matter:
+    - python-frontmatter
+    - beautifulsoup4
+    - lxml
+
+All of these libraries are needed so that the package can separate note text from front matter in a generalised approach.
 
 ## 🏗️ Tests
 A small 'dummy vault' vault of lipsum notes is in `tests/vault-stub` (generated with help of the [lorem-markdownum](https://github.com/jaspervdj/lorem-markdownum) tool).  Sense-checking on the API functionality was also done on a personal vault of up to 100 notes.
diff --git a/requirements.txt b/requirements.txt
index 16a13e5..94d2ad3 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,3 +5,4 @@ numpy
 networkx
 python-frontmatter
 beautifulsoup4
+lxml  # front matter parsing
diff --git a/setup.py b/setup.py
index 7055404..80a108d 100644
--- a/setup.py
+++ b/setup.py
@@ -11,7 +11,8 @@
     "numpy",
     "networkx",
     "python-frontmatter",
-    "beautifulsoup4"]
+    "beautifulsoup4",
+    "lxml"]
 
 CLASSIFIERS = [
     "Development Status :: 3 - Alpha",