Add documentation

qcovery · Feb 7, 2024 · b9c3ceb · b9c3ceb
1 parent 416037c
commit b9c3ceb
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,6 @@
-enhanced facet handler (yet only publishYear facet)
+# ExtendedFacets
+This module adds an enhanced way to display facets. Currently, it is capable of enhancing the publishYear facet.
+
+## Usage
+Integrate the module in the `modules` directory of VuFind and activate it by adding `ExtendedFacets` to `VUFIND_LOCAL_MODULES`.  
+When adding the module manually make sure to copy/symlink the theme.