From fa2d8486bd487c53c73f7230b930cf01b373beeb Mon Sep 17 00:00:00 2001 From: Matthias Richter <50573614+dikastes@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:06:05 +0200 Subject: [PATCH] Create README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2061f9a --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +The Music Publisher Database +============================ + +[![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/mpdb_core)](https://github.com/dikastes/mpdb_core/blob/main/LICENSE) + +This is the core module of the music publisher database, which is published under https://musikverlage.slub-dresden.de. + +# Installation + +After installing the extension, index your data with the following command: + +```bash +$ typo3 mpdb_core:index +``` + +Also take a look at the other commands for retrieving GND data and health checking the database. + +# Maintainer + +If you have any questions or encounter any problems, please do not hesitate to contact me. +- [Matthias Richter](https://github.com/dikastes)