Skip to content

Commit 6853f07

Browse files
authored
Update README.md (#65)
* Update Packagist version and downloads badges * Update info on continuous integration * Fix typo and text * Improve formatting * Add license badge
1 parent cc96b72 commit 6853f07

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
[![Build Status](https://img.shields.io/github/actions/workflow/status/SemanticMediaWiki/SemanticCompoundQueries/ci.yml?branch=master)](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/actions?query=workflow%3ACI)
44
[![Code Coverage](https://codecov.io/gh/SemanticMediaWiki/SemanticCompoundQueries/branch/master/graph/badge.svg)](https://codecov.io/gh/SemanticMediaWiki/SemanticCompoundQueries)
55
[![Latest Stable Version](https://poser.pugx.org/mediawiki/semantic-compound-queries/v/stable)](https://packagist.org/packages/mediawiki/semantic-compound-queries)
6-
[![Packagist download count](https://poser.pugx.org/mediawiki/semantic-compound-queries/downloads)](https://packagist.org/packages/mediawiki/semantic-compound-queries)
6+
[![Download count](https://poser.pugx.org/mediawiki/semantic-compound-queries/downloads)](https://packagist.org/packages/mediawiki/semantic-compound-queries)
7+
[![License](https://poser.pugx.org/mediawiki/semantic-media-wiki/license)](COPYING)
78

8-
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.
9+
Semantic Compound Queries (a.k.a. SCQ) is a [Semantic Mediawiki][smw] extension that defines the
10+
`#compound_query` parser function, which can display the results of multiple `#ask` queries
11+
(as compound constructs) at the same time.
912

1013
## Requirements
1114

@@ -34,7 +37,7 @@ create one and add the following content to it:
3437
}
3538
```
3639

37-
If you already have a "composer.local.json" file add the following line to the end of the "require"
40+
If you already have a "composer.local.json" file, add the following line to the end of the "require"
3841
section in your file:
3942

4043
"mediawiki/semantic-compound-queries": "~2.2"
@@ -47,7 +50,7 @@ Run the following command in your shell:
4750

4851
php composer.phar update --no-dev
4952

50-
Note if you have Git installed on your system add the `--prefer-source` flag to the above command.
53+
Note that if you have Git installed on your system, you can add the `--prefer-source` flag to the above command.
5154

5255
### Step 3
5356

@@ -58,9 +61,9 @@ Add the following line to the end of your "LocalSettings.php" file:
5861

5962
## Usage
6063

61-
The syntax of `#compound_query` resembles that of `#ask`, but with more than one query, and with the elements
62-
of each sub-query delimited by semicolons instead of pipes. Elements that are common across all sub-queries,
63-
like `format=` and `width=` (for maps) should be placed after all sub-queries.
64+
The syntax of `#compound_query` resembles that of `#ask`, but with more than one query and the elements
65+
of each sub-query delimited by semicolons instead of pipes. Elements common across all sub-queries,
66+
like `format=` and `width=` (for maps), should be placed after all sub-queries.
6467

6568
### Example
6669

@@ -86,25 +89,25 @@ For more information, see the extension's homepage at [MediaWiki.org][homepage].
8689

8790
Original author: Yaron Koren (Version 0.4.1)
8891

89-
If you want to contribute work to the project please subscribe to the developers mailing list and
90-
have a look at the contribution guideline.
92+
If you want to contribute work to the project, please subscribe to the developer's mailing list and
93+
have a look at the contribution guidelines.
9194

9295
* [File an issue](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/issues)
9396
* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticCompoundQueries/pulls)
9497
* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
9598

9699
## Tests
97100

98-
This extension provides unit and integration tests that are run by a [continues integration platform][travis]
99-
but can also be executed using `composer phpunit` from the extension base directory.
101+
This extension provides unit and integration tests and is run by a [continuous integration platform][github-actions]
102+
but can also be executed locally using the shortcut command `composer phpunit` from the extension base directory.
100103

101104
## License
102105

103106
[GNU General Public License, version 2 or later][gpl-licence].
104107

105108
[smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki
106109
[contributors]: https://github.com/SemanticMediaWiki/SemanticCompoundQueries/graphs/contributors
107-
[travis]: https://travis-ci.org/SemanticMediaWiki/SemanticCompoundQueries
110+
[github-actions]: https://docs.github.com/en/actions
108111
[gpl-licence]: https://www.gnu.org/copyleft/gpl.html
109112
[composer]: https://getcomposer.org/
110113
[homepage]: https://www.mediawiki.org/wiki/Extension:Semantic_Compound_Queries

0 commit comments

Comments
 (0)