Jeroen De Dauw has submitted this change and it was merged. Change subject: Update readme file to markdown ......................................................................
Update readme file to markdown Change-Id: I862b06addc60f830cae00805d25ee4e297be896e --- D README A README.md 2 files changed, 61 insertions(+), 12 deletions(-) Approvals: Jeroen De Dauw: Verified; Looks good to me, approved diff --git a/README b/README deleted file mode 100644 index dda0585..0000000 --- a/README +++ /dev/null @@ -1,12 +0,0 @@ -These is the readme file for the Wikibase Query extension. - -Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:Wikibase_Query - -== About == - -Wikibase Query adds query capabilities to Wikibase Repo. - -=== Feature overview === - -* New Query page type that allows people to define queries (in the Query namespace by default). -* Query execution against a query engine that returns a query result \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe6a84a --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Wikibase Query + +[](http://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQuery) +[](https://coveralls.io/r/wikimedia/mediawiki-extensions-WikibaseQuery?branch=master) + +On Packagist: +[](https://packagist.org/packages/wikibase/query) +[](https://packagist.org/packages/wikibase/query) + +Wikibase Query adds query capabilities to Wikibase Repo. + +Features: + +* New Query page type that allows people to define queries (in the Query namespace by default). +* Query execution against a query engine that returns a query result + +## Requirements + +* PHP 5.3 or later +* Wikibase Repo 0.5 or later +* Wikibase QueryEngine 0.1 or later +* Ask 1.x +* DataValues 0.1 or later +* Serialization 2.x + +## 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 `wikibase/query` to your project's `composer.json` file. +Here is a minimal example of a `composer.json` file that just defines a dependency on +Wikibase Query 1.0: + + { + "require": { + "wikibase/query": "1.0.*" + } + } + +## Tests + +This library comes with a set up PHPUnit tests that cover all non-trivial code. You can run these +tests using the PHPUnit configuration file found in the root directory. The tests can also be run +via TravisCI, as a TravisCI configuration file is also provided in the root directory. + +## Authors + +Wikibase Query has been written by [Jeroen De Dauw](https://www.mediawiki.org/wiki/User:Jeroen_De_Dauw) +as [Wikimedia Germany](https://wikimedia.de) employee for the [Wikidata project](https://wikidata.org/). + +## Links + +* [Wikibase Query on Packagist](https://packagist.org/packages/wikibase/query) +* [Wikibase Query on Ohloh](https://www.ohloh.net/p/wikibasequery) +* [Wikibase Query on MediaWiki.org](https://www.mediawiki.org/wiki/Extension:Wikibase_Query) +* [TravisCI build status](https://travis-ci.org/wikimedia/mediawiki-extensions-WikibaseQuery) \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/86430 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I862b06addc60f830cae00805d25ee4e297be896e Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/WikibaseQuery 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
