Skip to content

Commit 87ea546

Browse files
committed
README
1 parent b1726f7 commit 87ea546

File tree

1 file changed

+40
-7
lines changed

1 file changed

+40
-7
lines changed

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,51 @@
11
# SemanticFormsSelect MediaWiki Extension
22

3-
see http://www.mediawiki.org/wiki/Extension:SemanticFormsSelect for more information and examples.
3+
[![Packagist download count](https://poser.pugx.org/mediawiki/semantic-forms-select/d/total.png)](https://packagist.org/packages/mediawiki/semantic-forms-select)
44

55
Original code from https://code.google.com/p/semanticformsselect/downloads/list
66

7-
## Candidate 1.2 version
7+
## Requirements
88

9-
This is an update to make it work with newer MediaWiki versions.
9+
- PHP 5.3.2 or later
10+
- MediaWiki 1.23 or later
11+
- [Semantic MediaWiki][smw] 2.0 or later
12+
- [Semantic Forms][sf] 2.7 or later
1013

11-
For instance, since AJAX methods are deprecated in newer MediaWiki versions, they have been updated to API ones.
14+
## Installation
1215

13-
It can still be considered a preliminary alpha version. Use with caution.
16+
The recommended way to install Semantic Signup is by using [Composer][composer] with an entry in MediaWiki's `composer.json`.
1417

15-
## TODO
18+
```json
19+
{
20+
"require": {
21+
"mediawiki/semantic-forms-select": "~1.2"
22+
}
23+
}
24+
```
25+
1. From your MediaWiki installation directory, execute
26+
`composer require mediawiki/semantic-forms-select:~1.2`
27+
2. Navigate to _Special:Version_ on your wiki and verify that the package
28+
have been successfully installed.
1629

17-
* Polish different options (such as newly added label)
30+
## Usage
1831

32+
See http://www.mediawiki.org/wiki/Extension:SemanticFormsSelect for more information and examples.
33+
34+
## Contribution and support
35+
36+
If you want to contribute work to the project please subscribe to the developers mailing list and
37+
have a look at the contribution guideline.
38+
39+
* [File an issue](https://github.com/SemanticMediaWiki/SemanticFormsSelect/issues)
40+
* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticFormsSelect/pulls)
41+
* Ask a question on [the mailing list](https://semantic-mediawiki.org/wiki/Mailing_list)
42+
* Ask a question on the #semantic-mediawiki IRC channel on Freenode.
43+
44+
## License
45+
46+
[GNU General Public License, version 2 or later][gpl-licence].
47+
48+
[gpl-licence]: https://www.gnu.org/copyleft/gpl.html
49+
[smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki
50+
[sf]: https://www.mediawiki.org/wiki/Extension:Semantic_Forms
51+
[composer]: https://getcomposer.org/

0 commit comments

Comments
 (0)