Skip to content

Commit

Permalink
2.0.0 release (#26)
Browse files Browse the repository at this point in the history
* Update RELEASE-NOTES.md
** Provide information about the 2.0.0 release

* Update composer.json
** Increment dev alias to 2

* Update extension.json
** Increment version to 2.0.0

* Update README.md
** Adapt to new "developments" and for the new release
  • Loading branch information
kghbln authored Feb 18, 2019
1 parent 5accc50 commit c94e09e
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 13 deletions.
52 changes: 43 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,55 @@ This extension provides the `#mermaid` parser function to support the generation

## Installation

The recommended way to install Mermaid is by using [Composer][composer] with
an entry in MediaWiki's "composer.json" file or preferably "composer.local.json" file.
The recommended way to install this extension is using [Composer](http://getcomposer.org) with
[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer).

```json
### Step 1

Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php"
file is located. If you have not yet installed Composer do it now by running the following command
in your shell:

wget https://getcomposer.org/composer.phar

### Step 2

If you do not have a "composer.local.json" file yet, create one and add the following content to it:

```
{
"require": {
"mediawiki/mermaid": "~1.0"
"mediawiki/mermaid": "~2.0"
}
}
```
1. From your MediaWiki installation directory, execute
`composer require mediawiki/mermaid:~1.0`
2. Add `wfLoadExtension( 'Mermaid' );` to the "LocalSettings.php" file
3. Navigate to _Special:Version_ on your wiki and verify that the package
have been successfully installed.

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.0"

Remember to add a comma to the end of the preceding line in this section.

### Step 3

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 4

Add the following line to the end of your "LocalSettings.php" file:

wfLoadExtension( 'Mermaid' );

### Verify installation success

As final step, you can verify Mermaid got installed by looking at the "Special:Version" page on your wiki and
check that it is listed.

## Usage

Expand Down
9 changes: 8 additions & 1 deletion RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
This file contains the RELEASE-NOTES of the Mermaid extension.

### 2.0.0

Released on February 18, 2019

* Updates to using version 8.0.0 of the mermaid script language.
* Translation updates from https://translatewiki.net

### 1.0.1

Released on February 13, 2018.
Expand All @@ -11,6 +18,6 @@ Released on February 13, 2018.

Released on January 16, 2018.

* Initial release
* Initial release using version 7.0.5 of the mermaid script language.
* Added an `MERMAID` parser to easily generate diagrams and flowcharts with the help of the mermaid script language
* Localizations from https://translatewiki.net
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"license": "GPL-2.0-or-later",
"authors": [
{
"name": "mwjames",
"name": "James Hong Kong",
"role": "Developer"
}
],
Expand All @@ -21,7 +21,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "1.x-dev"
"dev-master": "2.x-dev"
}
},
"autoload": {
Expand Down
2 changes: 1 addition & 1 deletion extension.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Mermaid",
"version": "1.1.0-alpha",
"version": "2.0.0",
"author": [
"James Hong Kong"
],
Expand Down

0 comments on commit c94e09e

Please sign in to comment.