Update README, add required steps under "Configuration"

same issue, i set it up with the submodule glossify taxonomy tootips, the settings are correct but don't work, no error.. only i i go to /admin/structure/views and i ownload a .csv from my own view, after reload i riceve this error:

arning: DOMDocumentFragment::appendXML(): Entity: line 4: parser error : Double hyphen within comment: <!-- FILE NAME SUGGESTIONS: * glossify-link in Drupal\glossify\GlossifyBase->parseTooltipMatch() (line 184 of modules/contrib/glossify/src/GlossifyBase.php).

Drupal\glossify\GlossifyBase->parseTooltipMatch('Lorem ipsum demo text', Array, '0', '1', 'links', '0', '/taxonomy/term/[id]', 'de') (Line: 166)
Drupal\glossify_taxonomy\Plugin\Filter\TaxonomyTooltip->process('Lorem ipsum demo text .......

@drupaldope , are you sure you have any node with the exact same title that any of your content words/phrases? Test with a vocabulary, if you have one and maybe it will be easier for you to debug. Or use links instead tooltips, and be sure your links are visible (text-decoration, etc).

In my hand I think the README text should to notice that it's not enough enabling the main module, and you need to activate one of the two submodules (nodes or taxonomies)

I agree the README could be improved by adding that information. I'll update the README.

Here's an updated README, with the minimal steps to set it up. Is it clearer now, or is more details needed, @calbasi and @drupaldope?

You can click 3315451-update-README for a preview.

@terminator727: Perhaps you can create separate issue for your error?

Commited, thanks @ressa!

Automatically closed - issue fixed for 2 weeks with no activity.