Skip to content

Commit 041c16d

Browse files
authored
Update README.md (#26)
1 parent 6c4c99e commit 041c16d

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ It should also be possible to add the module definition to the `extension.json`
2020
of a MediaWiki extension. See
2121
[Developing_with_ResourceLoader](https://www.mediawiki.org/wiki/ResourceLoader/Developing_with_ResourceLoader)
2222

23-
There are some additional keys, that may be used:
23+
Some additional keys may be used:
2424
* `class`:
2525
This is mandatory. It selects the class to be used for the module. For
26-
SCSS the value has to be `'SCSS\\ResourceLoaderSCSSModule'`
26+
SCSS, the value has to be `'SCSS\\ResourceLoaderSCSSModule'`
2727
* `styles`:
28-
Not really an additional key, but it has extended semantics. This key
29-
contains the list of style files of the module. Each file can optionally be
28+
It is not an additional key, but it has extended semantics. This key
29+
contains the list of the module's style files. Each file can optionally be
3030
given a position to influence the order in which the files are compiled.
3131
Allowed values for the position are
3232
1. `beforeFunctions`
@@ -41,21 +41,21 @@ There are some additional keys, that may be used:
4141

4242
If no position is given, `main` will be assumed.
4343

44-
All files of one module will be compiled together, i.e. variables, mixins
45-
etc. will be shared between them.
44+
All files of one module will be compiled together, i.e., variables, mixins
45+
etc., will be shared between them.
4646

4747
* `variables`:
4848
An array of variables and values to override the SCSS variables in the
49-
style files. This allows changing values (e.g. colors, fonts, margins)
49+
style files. This allows changing values (e.g., colors, fonts, margins)
5050
without having to modify the actual style files.
5151
* `cacheTriggers`:
5252
Compiling SCSS is expensive, so compiled results are cached. This option
53-
lists files that when changed will trigger a flushing of the cache and
54-
re-compiling the style files.
53+
lists files that, when changed, will trigger flushing of the cache and
54+
re-compiling of the style files.
5555

5656
All files on this list will be checked for each web request. To minimizes the
57-
load on the file system and the time to build the page it is not advisable
58-
to just add all style files to this list.
57+
load on the file system and the time to build the page, it is not advisable
58+
to add all style files to this list.
5959

6060
Here is an example definition:
6161
```php
@@ -89,15 +89,15 @@ compiler, which has some limitations. See the
8989

9090
### Cache type
9191

92-
`$egScssCacheType` can be set to request a specific cache type to be used for
93-
the compiled styles. To disable caching of SCSS styles completely (e.g. during
94-
development), set `$egScssCacheType = CACHE_NONE;`. This should obviously never
95-
be done on a production site.
92+
`$egScssCacheType` can be set to request a specific cache type for the compiled
93+
styles. To disable caching of SCSS styles altogether (e.g., during development),
94+
set `$egScssCacheType = CACHE_NONE;`. This should never be done on a production
95+
site.
9696

9797
## Professional Support
9898

99-
The SCSS extension is maintained by [Professional.Wiki](https://professional.wiki).
100-
You can [contract us][contact-form] to help you with installation or customization of SCSS.
99+
The SCSS extension is maintained by [Professional Wiki](https://professional.wiki).
100+
You can [contract us][contact-form] to help you install or customize SCSS.
101101
We also do development work.
102102

103103
## Running the tests
@@ -180,7 +180,7 @@ Released on 2020-09-07
180180

181181
Released on 2020-09-07
182182

183-
* Temporarily fixed the version of `scssphp` to 1.1.1 to avoid 1.2 bug
183+
* Temporarily fixed the version of `scssphp` to 1.1.1 to avoid the 1.2 bug
184184

185185
### Version 2.0
186186

@@ -191,4 +191,6 @@ Released on 2020-04-19
191191

192192
### Version 1.0
193193

194-
Initial release
194+
Released on 2019-04-28
195+
196+
* Initial release

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
"role": "Developer"
2323
},
2424
{
25-
"name": "Professional.Wiki",
25+
"name": "Professional Wiki",
2626
"email": "[email protected]",
27-
"homepage": "https://professional.wiki",
27+
"homepage": "https://professional.wiki/en/mediawiki-development",
2828
"role": "Maintainer"
2929
}
3030
],

0 commit comments

Comments
 (0)