From 9eb19449fbc545bc26c1407b64a67bff72ed8744 Mon Sep 17 00:00:00 2001 From: Karsten Hoffmeyer Date: Fri, 26 Jul 2024 09:37:30 +0200 Subject: [PATCH] Update README.md * Update Packagist version and downloads badges * Update info on continuous integration * Fix typo and text * Improve formatting --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b9804d3..b00b32a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Semantic Compound Queries -[![Build Status](https://secure.travis-ci.org/SemanticMediaWiki/SemanticCompoundQueries.svg?branch=master)](http://travis-ci.org/SemanticMediaWiki/SemanticCompoundQueries) +[![CI](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/actions/workflows/ci.yml/badge.svg)](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/actions/workflows/ci.yml) [![Code Coverage](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticCompoundQueries/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticCompoundQueries/?branch=master) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticCompoundQueries/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticCompoundQueries/?branch=master) -[![Latest Stable Version](https://poser.pugx.org/mediawiki/semantic-compound-queries/version.png)](https://packagist.org/packages/mediawiki/semantic-compound-queries) -[![Packagist download count](https://poser.pugx.org/mediawiki/semantic-compound-queries/d/total.png)](https://packagist.org/packages/mediawiki/semantic-compound-queries) +![Latest Stable Version](https://img.shields.io/packagist/v/mediawiki/semantic-compound-queries.svg) +![Total Download Count](https://img.shields.io/packagist/dt/mediawiki/semantic-compound-queries.svg) -Semantic Compound Queries (a.k.a. SCQ) is a [Semantic Mediawiki][smw] extension that defines the `#compound_query` parser function which can display results of multiple `#ask` queries (as compound construct) at the same time. +Semantic Compound Queries (a.k.a. SCQ) is a [Semantic Mediawiki][smw] extension that defines the +`#compound_query` parser function, which can display the results of multiple `#ask` queries +(as compound constructs) at the same time. ## Requirements @@ -35,7 +36,7 @@ create one and add the following content to it: } ``` -If you already have a "composer.local.json" file add the following line to the end of the "require" +If you already have a "composer.local.json" file, add the following line to the end of the "require" section in your file: "mediawiki/semantic-compound-queries": "~2.2" @@ -48,7 +49,7 @@ Run the following command in your shell: php composer.phar update --no-dev -Note if you have Git installed on your system add the `--prefer-source` flag to the above command. +Note that if you have Git installed on your system, you can add the `--prefer-source` flag to the above command. ### Step 3 @@ -59,9 +60,9 @@ Add the following line to the end of your "LocalSettings.php" file: ## Usage -The syntax of `#compound_query` resembles that of `#ask`, but with more than one query, and with the elements -of each sub-query delimited by semicolons instead of pipes. Elements that are common across all sub-queries, -like `format=` and `width=` (for maps) should be placed after all sub-queries. +The syntax of `#compound_query` resembles that of `#ask`, but with more than one query and the elements +of each sub-query delimited by semicolons instead of pipes. Elements common across all sub-queries, +like `format=` and `width=` (for maps), should be placed after all sub-queries. ### Example @@ -87,8 +88,8 @@ For more information, see the extension's homepage at [MediaWiki.org][homepage]. Original author: Yaron Koren (Version 0.4.1) -If you want to contribute work to the project please subscribe to the developers mailing list and -have a look at the contribution guideline. +If you want to contribute work to the project, please subscribe to the developer's mailing list and +have a look at the contribution guidelines. * [File an issue](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/issues) * [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/pulls) @@ -96,8 +97,8 @@ have a look at the contribution guideline. ## Tests -This extension provides unit and integration tests that are run by a [continues integration platform][travis] -but can also be executed using `composer phpunit` from the extension base directory. +This extension provides unit and integration tests and is run by a [continuous integration platform][github-actions] +but can also be executed locally using the shortcut command `composer phpunit` from the extension base directory. ## License @@ -105,7 +106,7 @@ but can also be executed using `composer phpunit` from the extension base direct [smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki [contributors]: https://github.com/SemanticMediaWiki/SemanticCompoundQueries/graphs/contributors -[travis]: https://travis-ci.org/SemanticMediaWiki/SemanticCompoundQueries +[github-actions]: https://docs.github.com/en/actions [gpl-licence]: https://www.gnu.org/copyleft/gpl.html [composer]: https://getcomposer.org/ [homepage]: https://www.mediawiki.org/wiki/Extension:Semantic_Compound_Queries