BamLifa has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/401790 )
Change subject: updated the README file ...................................................................... updated the README file Change-Id: Ide0be5f81b4d45543b0b3ddf1635e35100931cdc --- M README.md 1 file changed, 34 insertions(+), 10 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SendGrid refs/changes/90/401790/1 diff --git a/README.md b/README.md index 4f26292..071ec6d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,39 @@ # SendGrid MediaWiki Extension -This is a Github mirror of MediaWiki extension SendGrid - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing). +SendGrid is an extension that allows MediaWiki to send emails through SendGrid API service. +* Author: Alangi Derick +* 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; +* 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: +* 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. + +## 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. + +## More information + +Go to the relevant page on [MediaWiki](https://www.mediawiki.org/wiki/Extension:SendGrid) +## License -# View SendGrid package using the link below; - -Github SendGrid package: https://github.com/stephenb/sendgrid. - - - -# Installing the SendGrid Extension on MW - -To install this extension on MediaWiki (MW), follow the documentations here: https://www.mediawiki.org/wiki/Extension:SendGrid \ No newline at end of file +SendGrid is licensed under the terms of the GNU General Public License 2.0 or later. -- To view, visit https://gerrit.wikimedia.org/r/401790 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ide0be5f81b4d45543b0b3ddf1635e35100931cdc 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
