BamLifa has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/403885 )
Change subject: SendGrid MW Ext: Update README ...................................................................... SendGrid MW Ext: Update README The README file was still skeletal since the first release of the extension. This commit explains how to install the extension and how to contribute to the project. Some usefull info have been added too: author, license, etc. Bug: T176575 Change-Id: Ie8120269cb16064941312c75da6cb27e02c243b3 --- M README.md 1 file changed, 15 insertions(+), 10 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SendGrid refs/changes/85/403885/1 diff --git a/README.md b/README.md index 071ec6d..953a614 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,37 @@ # SendGrid MediaWiki Extension -SendGrid is an extension that allows MediaWiki to send emails through SendGrid API service. +SendGrid is an extension that allows MediaWiki to send emails through SendGrid +API service. * Author: Alangi Derick -* Current release: 1.0 -* MediaWiki: 1.25+ +* Current release: 1.0 +* MediaWiki: 1.25+ * PHP: 5.6+ * License: GNU GPL2+ ## Installation * Make sure you have already a MediaWiki environment installed; -* [Download](https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SendGrid) the **SendGrid** extension; -* Place the file(s) in a directory called ``SendGrid`` in your ``extensions/`` folder; +* [Download](https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SendGrid) +the **SendGrid** extension; +* Place the file(s) in a directory called ``SendGrid`` in your ``extensions/`` +folder; * Add the following code at the bottom of your [LocalSettings.php](https://www.mediawiki.org/wiki/Manual:LocalSettings.php): ```php wfLoadExtension( 'SendGrid' ); ``` - -For MediaWiki 1.24 or earlier: +For MediaWiki 1.24 or earlier: * Add the following code at the bottom of your [LocalSettings.php](https://www.mediawiki.org/wiki/Manual:LocalSettings.php): ```php require_once "$IP/extensions/SendGrid/SendGrid.php"; ``` - **Note:** You will have to run composer update in extensions/SendGrid/ folder so that composer can pick up the required SendGrid dependencies for the extension to run smoothly. + **Note:** You will have to run composer update in extensions/SendGrid/ folder + so that composer can pick up the required SendGrid dependencies for the + extension to run smoothly. ## Contribute -Please refer to [https://phabricator.wikimedia.org/tag/mediawiki-extensions-sendgrid/](https://phabricator.wikimedia.org/tag/mediawiki-extensions-sendgrid/)for tasks on which you can contribute to. +Please refer to [https://phabricator.wikimedia.org/tag/mediawiki-extensions-sendgrid/](https://phabricator.wikimedia.org/tag/mediawiki-extensions-sendgrid/) for tasks on which you can contribute to. ## More information @@ -36,4 +40,5 @@ ## License -SendGrid is licensed under the terms of the GNU General Public License 2.0 or later. +SendGrid is licensed under the terms of the GNU General Public License 2.0 or +later. -- To view, visit https://gerrit.wikimedia.org/r/403885 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ie8120269cb16064941312c75da6cb27e02c243b3 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/SendGrid Gerrit-Branch: master Gerrit-Owner: BamLifa <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
