Streamline header formatting in README.md

- Streamline header formatting.
- Fix detection of API documentation section in README.md.

Author: alexander-nitsche

README.md

@@ -1,14 +1,15 @@
-Syllable
-========
+# Syllable
+
 Version 1.6
 
 [![Tests](https://github.com/vanderlee/phpSyllable/actions/workflows/tests.yml/badge.svg)](https://github.com/vanderlee/phpSyllable/actions/workflows/tests.yml)
 
 Copyright © 2011-2023 Martijn van der Lee.
 MIT Open Source license applies.
 
-Introduction
-------------
+
+## Introduction
+
 PHP Syllable splitting and hyphenation.
 or rather...
 PHP Syl-la-ble split-ting and hy-phen-ation.
@@ -23,8 +24,8 @@ Language sources: http://tug.org/tex-hyphen/#languages
 
 Supports PHP 5.6 and up, so you can use it on older servers.
 
-Installation
-------------
+
+## Installation
 
 Install phpSyllable via Composer
 
@@ -35,8 +36,8 @@ composer require vanderlee/syllable
 or simply add phpSyllable to your project and set up the project's 
 autoloader for phpSyllable's src/ directory.
 
-Usage
------
+
+## Usage
 
 Instantiate a Syllable object and start hyphenation.
 
@@ -81,8 +82,9 @@ echo $syllable->hyphenateText('Provide your own paragraphs...');
 
 See the [demo.php](demo.php) file for a working example.
 
-`Syllable` API reference
---------------------------
+
+## `Syllable` API reference
+
 The following is an incomplete list, containing only the most common methods.
 For a complete documentation of all classes, read the generated [PHPDoc](doc).
 
@@ -210,8 +212,8 @@ Count the number of syllables in the text.
 
 Count the number of polysyllables in the text.
 
-Development
------------
+
+## Development
 
 ### Update language files
 
@@ -318,8 +320,8 @@ composer install
 to execute the tests.
 
 
-Changes
--------
+## Changes
+
 1.6
 -   Revert renaming of API method names
 -   Use cache version as string instead of number

build/classes/DocumentationManager.php

@@ -146,15 +146,19 @@ protected function updateReadme()
             $apiDocumentation .= '#### '.$method['signature']."\n\n";
             $apiDocumentation .= $method['comment'] !== '' ? $method['comment']."\n\n" : '';
         }
+        $apiDocumentation .= "\n";
 
         $readme = file_get_contents($this->readmeFile);
-        $apiDocumentationStart = strpos($readme, '####', strpos($readme, "`Syllable` API reference\n--------------------------"));
-        $apiDocumentationEnd = strpos($readme, "Development\n-----------", $apiDocumentationStart);
-        $apiDocumentationLength = $apiDocumentationEnd - $apiDocumentationStart;
+        $apiDocumentationStart = strpos($readme, '## `Syllable` API reference');
+        if ($apiDocumentationStart !== false) {
+            $apiDocumentationStart = strpos($readme, '####', $apiDocumentationStart);
+            $apiDocumentationEnd = strpos($readme, '## Development', $apiDocumentationStart);
+        }
+
         $apiDocumentationOld = '';
         $readmeState = 0;
-
-        if ($apiDocumentationStart > -1 && $apiDocumentationEnd > -1) {
+        if ($apiDocumentationStart !== false && $apiDocumentationEnd !== false) {
+            $apiDocumentationLength = $apiDocumentationEnd - $apiDocumentationStart;
             $apiDocumentationOld = substr($readme, $apiDocumentationStart, $apiDocumentationLength);
             $readme = substr_replace($readme, $apiDocumentation, $apiDocumentationStart, $apiDocumentationLength);
             $readmeState += 1;

tests/build/DocumentationManagerTest.php

@@ -42,23 +42,23 @@ protected function tearDownFixture()
     public function delegateSucceeds()
     {
         $readme = trim('
-`Syllable` API reference
---------------------------
+## `Syllable` API reference
+
 The following is an incomplete list, containing only the most common methods.
 For a complete documentation of all classes, read the generated [PHPDoc](doc).
 
 #### public setMethods(array $methods = [])
 
 ..
 
-Development
------------
+
+## Development
         ');
 
         $expectedOutputRegex = '#The API documentation in the README.md has CHANGED.#';
         $expectedReadme = trim('
-`Syllable` API reference
---------------------------
+## `Syllable` API reference
+
 The following is an incomplete list, containing only the most common methods.
 For a complete documentation of all classes, read the generated [PHPDoc](doc).
 
@@ -75,8 +75,8 @@ public function delegateSucceeds()
 
 The public static method.
 
-Development
------------
+
+## Development
         ');
 
         $this->createFileInTestDirectory('README.md', $readme);
@@ -99,17 +99,17 @@ public function delegateSucceeds()
     public function delegateFailsIfReadmeFormatChanges()
     {
         $readme = trim('
-Syllable class reference
---------------------------
+## Syllable API reference
+
 The following is an incomplete list, containing only the most common methods.
 For a complete documentation of all classes, read the generated [PHPDoc](doc).
 
 #### public setMethods(array $methods = [])
 
 ..
 
-Examples
---------
+
+## Development
         ');
 
         $expectedOutput = trim('