Convert README.txt to Readme.md
Closes #3482195
Merge request reports
Activity
1 ## CONTENTS OF THIS FILE 2 3 * Introduction 4 * Requirements 5 * Installation 6 * Configuration 7 * Page specific tracking 8 * Suggestions or issues 1 The module provides 9 2 10 ## INTRODUCTION 3 * For a full description of the module, visit the project page: 4 https://www.drupal.org/project/piwik_pro I think we could replace these with markdown links project page.
changed this line in version 2 of the diff
1 ## CONTENTS OF THIS FILE The first line should be:
Piwik PRO
I also like the approach for example from Search API Solr that there is a short introcution after the h1 title before the table of contents: https://git.drupalcode.org/project/search_api_solr/-/raw/4.x/README.md?ref_type=heads.
For example: A simple module to add the Piwik PRO container (with tracking code) to your Drupal site, making it easy to collect visitor data from any Drupal site.
2 3 * Introduction 4 * Requirements 5 * Installation 6 * Configuration 7 * Page specific tracking 8 * Suggestions or issues 1 The module provides 9 2 10 ## INTRODUCTION 3 * For a full description of the module, visit the project page: 4 https://www.drupal.org/project/piwik_pro 11 5 12 The module provides 6 * To submit bug reports and feature suggestions, or to track changes: 7 https://www.drupal.org/project/issues/piwik_pro changed this line in version 2 of the diff
1 ## CONTENTS OF THIS FILE 2 3 * Introduction 4 * Requirements 5 * Installation 6 * Configuration 7 * Page specific tracking 8 * Suggestions or issues 1 The module provides 9 2 10 ## INTRODUCTION 3 * For a full description of the module, visit the project page: 4 https://www.drupal.org/project/piwik_pro 11 5 12 The module provides 6 * To submit bug reports and feature suggestions, or to track changes: changed this line in version 2 of the diff
7 * Page specific tracking 8 * Suggestions or issues 1 The module provides 9 2 10 ## INTRODUCTION 3 * For a full description of the module, visit the project page: 4 https://www.drupal.org/project/piwik_pro 11 5 12 The module provides 6 * To submit bug reports and feature suggestions, or to track changes: 7 https://www.drupal.org/project/issues/piwik_pro 13 8 14 * For a full description of the module, visit the project page: 15 https://www.drupal.org/project/piwik_pro 9 * Note that this is not for the original Piwik (or later Matomo). For 10 these products, please use https://www.drupal.org/project/matomo changed this line in version 2 of the diff
17 * [Page specific tracking](#Page-specific-tracking) 18 * [Suggestions or issues](#Suggestions-or-issues) 22 19 23 20 24 ## REQUIREMENTS 21 ## Requirements 25 22 26 23 This module requires no modules outside of Drupal core. 27 24 You must register for a Piwik-Pro account. 28 25 29 26 30 ## INSTALLATION 27 ## Installation 31 28 32 29 * Install the Piwik Pro module as you would normally install a 33 30 contributed Drupal module. Visit https://www.drupal.org/node/1897420 for Let's add this in a similar fashion as Search API Solr does: Install as you would normally install a contributed Drupal module. For further information, see Installing Drupal Modules.
changed this line in version 3 of the diff
55 54 /user/*/* 56 55 ``` 57 56 58 These defaults are changeable by the website administrator or any other 59 user with 'Administer Piwik Pro' permission. 60 61 ## SUGGESTIONS OR ISSUES 57 ## Suggestions or issues changed this line in version 3 of the diff
added 1 commit
- 4e6f5b70 - Issue 3482195: Change README.md casing and add introduction.
added 1 commit
- adfec41e - Issue 3482195: Reformat installation message and remove suggest ideas paragraph.