Update docu and files for the upcoming release (#55)

* Update extension.json * Bump to amended alpha version [skip ci] * Update README.md * Bump minimum requirement for PHP [skip ci] * Update composer.json * Update extension's description * Update minimum PHP requirement * Update dev branch alias [skip ci] * Update INSTALL.md * Update documentation * Tweak content [skip ci] * Update RELEASE-NOTES.md Update notes [skip ci]
SemanticMediaWiki · Aug 7, 2020 · aca715f · aca715f
1 parent 1c23488
commit aca715f
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ This extension provides the `#mermaid` parser function to support the generation
 
 ## Requirements
 
-- PHP 5.6 or later
+- PHP 7.0 or later
 - MediaWiki 1.33 or later
 
 ## Installation and configuration

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
 	"name": "mediawiki/mermaid",
 	"type": "mediawiki-extension",
-	"description": "Provides a parser function to generate diagrams and flowcharts with the help of the mermaid script language",
+	"description": "Provides a parser function to generate diagrams and charts with the help of the mermaid script language",
 	"keywords": [
 		"mediawiki",
 		"mermaid",
@@ -20,12 +20,12 @@
 		}
 	],
 	"require": {
-		"php": ">=5.6.0",
+		"php": ">=7.0.0",
 		"composer/installers": "1.*,>=1.0.1"
 	},
 	"extra": {
 		"branch-alias": {
-			"dev-master": "2.x-dev"
+			"dev-master": "3.x-dev"
 		}
 	},
 	"autoload": {

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -1,5 +1,5 @@
-This file contains the *installation and configuration instructions* for the **Mermaid** extension. See also the
-[readme], the [release notes] and [usage examples].
+This file contains the *installation and configuration instructions* for the **Mermaid** extension.
+See also the [readme], the [release notes] and [usage examples].
 
 ## Installation
 
@@ -13,15 +13,15 @@ If you do not have a "composer.local.json" file yet, create one and add the foll
 ```
 {
 	"require": {
-		"mediawiki/mermaid": "~2.3"
+		"mediawiki/mermaid": "~3.0"
 	}
 }
 ```
 
 If you already have a "composer.local.json" file add the following line to the end of the "require"
 section in your file:
 
-    "mediawiki/mermaid": "~2.3"
+    "mediawiki/mermaid": "~3.0"
 
 Remember to add a comma to the end of the preceding line in this section.
 
@@ -31,9 +31,6 @@ Run the following command in your shell:
 
     php composer.phar update --no-dev
 
-Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also
-note that it may be necessary to run this command twice. If unsure do it twice right away.
-
 ### Step 3
 
 Add the following line to the end of your "LocalSettings.php" file:
@@ -43,8 +40,8 @@ Add the following line to the end of your "LocalSettings.php" file:
 
 ## Configuration
 
-One configuration parameter is provided allowing to choose the basic theme for rendereing the graphs, diagrams
-and charts. By default the rendering is set to use the `forest` theme:
+One configuration parameter is provided allowing to choose the basic theme for rendering diagrams and charts.
+By default the rendering is set to use the `forest` theme:
 
     $mermaidgDefaultTheme = 'forest';
 
@@ -61,7 +58,8 @@ In order to update this repo for future updates, clone this repo and run
     yarn install
 
 This will pull from the upstream repo and patch the dist js file to load for the mediawiki extension.
-Commit any changes and PR back to this repo to put back into the composer packages.
+Commit any changes and create a pull request back to the Mermaid extension's repo to put back into the
+composer packages.
 
 [readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md
 [release notes]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/RELEASE-NOTES.md

diff --git a/docs/RELEASE-NOTES.md b/docs/RELEASE-NOTES.md
@@ -1,14 +1,16 @@
 This file contains the *release notes* of the **Mermaid** extension. See also the
 [readme], the [installation and configuration information] and [usage examples].
 
-### 2.3.0
+### 3.0.0
 
-Released xxx xx, 2020
+Released xxx xx, 2020.
 
-* Updates to using 8.5.0
-* Refactors the repo to use new Extension.json schema
-* Adds support for all configuration options
-* Enables direct future upstream updates from main Mermaid repo
+* Removes compatibility for MediaWiki 1.32 and earlier
+* Removes compatibility for PHP 5.6
+* Updates to using version 8.5.0 of the mermaid script language
+* Adds support for all configuration options provided by the mermaid script language
+* Refactors the repository to use the new extension registrion mechanism ("extension.json" schema)
+* Enables direct future upstream updates from main MermaidJS code repository
 
 ### 2.2.0
 
@@ -27,7 +29,6 @@ Released on May 20, 2019.
 
 Released on March 5, 2019.
 
-* Drops support for MediaWiki 1.32 and earlier
 * Removes deprecated `mediawiki.api.parse` alias
 
 ### 2.0.0

diff --git a/extension.json b/extension.json
@@ -1,6 +1,6 @@
 {
 	"name": "Mermaid",
-	"version": "2.3.0-alpha",
+	"version": "3.0.0-alpha",
 	"author": [
 			"James Hong Kong",
 			"Tyler Gibson"