From 587b441778537969e631dcee5aa4f26d2f26688b Mon Sep 17 00:00:00 2001
From: Matthias Richter <50573614+dikastes@users.noreply.github.com>
Date: Thu, 1 Feb 2024 14:03:10 +0100
Subject: [PATCH] Create README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..938091b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+The Bibliography Module of the Liszt Portal
+===========================================
+
+[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg)](https://get.typo3.org/version/11)
+[![CC-BY](https://img.shields.io/github/license/dikastes/liszt_catalograisonne)](https://github.com/dikastes/liszt_catlograisonne/blob/main/LICENSE)
+
+This module fetches bibliographical entries from the Zotero API and stores them in a search engine index.
+It provides a streamlined frontend plugin for browsing the bibliography.
+
+# How to use the module
+
+In the extension configuration, provide your Zotero API key, group and user id and the size of the bulk in which entries shall be retrieved from Zotero.
+Define names for your indices and the bulksize for indexing.
+Then, execute
+
+    $ typo3 liszt_bibliography:index
+
+The plugin may be included on a page using the New Content Element Wizard.