jenkins-bot has submitted this change and it was merged. Change subject: Update readme file ......................................................................
Update readme file Change-Id: I3817f9d68d5c2a3606e59997a635d2284268984b --- D README A README.md 2 files changed, 70 insertions(+), 16 deletions(-) Approvals: Jeroen De Dauw: Looks good to me, approved jenkins-bot: Verified diff --git a/README b/README deleted file mode 100644 index fde66b8..0000000 --- a/README +++ /dev/null @@ -1,16 +0,0 @@ -These is the readme file for the DataTypes library. - -Extension page on mediawiki.org: https://www.mediawiki.org/wiki/Extension:DataTypes -Latest version of the readme file: https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/DataValues.git;a=blob;f=DataTypes/README - -== About == - -DataTypes defines a collection of data types. -A data type consists out of: - -* An unique type identifier -* An internationalized label -* Information which data value type is used for representing values of the data type -* Zero or one ValueParser -* Zero or one ValueFormatter -* Zero or more ValueValidator objects \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..81f3164 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# DataTypes + +PHP library defining the DataTypes\DataType class. + +[](http://travis-ci.org/wikimedia/mediawiki-extensions-DataTypes) +[](https://coveralls.io/r/wikimedia/mediawiki-extensions-DataTypes?branch=master) +[](https://www.versioneye.com/package/php--data-values--data-types) + +On [Packagist](https://packagist.org/packages/data-values/data-types): +[](https://packagist.org/packages/data-values/data-types) +[](https://packagist.org/packages/data-values/data-types) + +## Requirements + +* PHP 5.3 or later +* [DataValues](https://www.mediawiki.org/wiki/Extension:DataValues) 0.1 or later +* [DataValues](https://www.mediawiki.org/wiki/Extension:ValueValidators) 0.1 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 `data-values/data-types` to your project's `composer.json` file. +Here is a minimal example of a `composer.json` file that just defines a dependency on +DataTypes 1.0: + + { + "require": { + "data-values/data-types": "1.0.*" + } + } + +### Manual + +Get the DataTypes 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 DataTypes library by including its entry point: +DataTypes.php. + +## 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 + +DataTypes has been written by the Wikidata team at [Wikimedia Germany](https://wikimedia.de) +for the [Wikidata project](https://wikidata.org/). + +## Release notes + +### 0.1 (under development) + +Initial release with these features: + +* + +## Links + +* [DataTypes on Packagist](https://packagist.org/packages/data-values/data-types) +* [DataTypes on Ohloh](https://www.ohloh.net/p/DataTypesPHP) +* [DataTypes on MediaWiki.org](https://www.mediawiki.org/wiki/Extension:DataTypes) +* [TravisCI build status](https://travis-ci.org/wikimedia/mediawiki-extensions-DataTypes) +* [Latest version of the readme file](https://github.com/wikimedia/mediawiki-extensions-DataTypes/blob/master/README.md) \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/80010 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I3817f9d68d5c2a3606e59997a635d2284268984b Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/DataTypes Gerrit-Branch: master Gerrit-Owner: Jeroen De Dauw <jeroended...@gmail.com> Gerrit-Reviewer: Addshore <addshorew...@gmail.com> Gerrit-Reviewer: Daniel Werner <daniel.wer...@wikimedia.de> Gerrit-Reviewer: Henning Snater <henning.sna...@wikimedia.de> Gerrit-Reviewer: Jeroen De Dauw <jeroended...@gmail.com> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
