Jeroen De Dauw has submitted this change and it was merged. Change subject: Update README file ......................................................................
Update README file Change-Id: I27bd62424bd017ae3ed30cdcc5896deacc257851 --- M README.md 1 file changed, 42 insertions(+), 6 deletions(-) Approvals: Jeroen De Dauw: Verified; Looks good to me, approved diff --git a/README.md b/README.md index 993aea6..d3762cd 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,52 @@ +# Ask + +[](https://packagist.org/packages/ask/ask) +[](https://packagist.org/packages/ask/ask) [](http://travis-ci.org/wikimedia/mediawiki-extensions-Ask) -About -===== - Library containing a PHP implementation of the Ask query language + +## Requirements + +* PHP 5.3 or later +* [DataValues](https://www.mediawiki.org/wiki/Extension:DataValues) 0.1 or later +* [Serialization](https://github.com/wikimedia/mediawiki-extensions-Serialization/blob/master/README.md) 1.0 or later + +## Installation + +You can use [Composer](http://getcomposer.org/) to download and install +this package as well as its dependencies. Alternatively you can simply clone +the git repository and take care of loading yourself. + +### Composer + +To add this package as a local, per-project dependency to your project, simply add a +dependency on `ask/ask` to your project's `composer.json` file. +Here is a minimal example of a `composer.json` file that just defines a dependency on +Ask 1.0: + + { + "require": { + "ask/ask": "1.0.*" + } + } + +### Manual + +Get the Ask code, either via git, or some other means. Also get all dependencies. +You can find a list of the dependencies in the "require" section of the composer.json file. +Load all dependencies and the load the Ask library by including its entry point: +Ask.php. + +## Usage The [extension page on mediawiki.org](https://www.mediawiki.org/wiki/Extension:Ask) contains the documentation and examples for this library. -Links ------ +## Links -* [Canonical git repo](https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Ask.git) * [Ask on Packagist](https://packagist.org/packages/ask/ask) +* [Ask on Ohloh](https://www.ohloh.net/p/ask) +* [Ask on MediaWiki.org](https://www.mediawiki.org/wiki/Extension:Ask) +* [TravisCI build status](https://travis-ci.org/wikimedia/mediawiki-extensions-Ask) * [Latest version of the readme file](https://github.com/wikimedia/mediawiki-extensions-Ask/blob/master/README.md) \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/73627 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I27bd62424bd017ae3ed30cdcc5896deacc257851 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Ask Gerrit-Branch: master Gerrit-Owner: Jeroen De Dauw <jeroended...@gmail.com> Gerrit-Reviewer: Jeroen De Dauw <jeroended...@gmail.com> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
