Skip to content

Commit 9aebb7e

Browse files
author
Simon Foster
committed
Documentation update
1 parent c8ba3e0 commit 9aebb7e

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ The script can be passed a number of parameters which allow its behaviour to be
1212

1313
Some of these require a passphrase to be passed to authenticate the request.
1414

15-
### pp=<<passphrase>>
15+
### pp={{passphrase}}
1616
This passphrase needs to match that set in the script.
1717

18-
### cmd=<<command>>
18+
### cmd={{command}}
1919
The command you wish to perform. Some are passed alongside the image request and others direct to the script.
2020

2121
**nocache**
@@ -45,11 +45,22 @@ At the head of the file there are a number of configurable options -
4545

4646
### $allowedSizes
4747
An array containing a list of sizes that can be requested, specified as a string '400x400' etc.
48-
48+
```
49+
$allowedSizes = array('100x100', '600x400');
50+
```
4951
If this is null then any size can be requested.
52+
```
53+
$allowedSizes = null;
54+
```
5055

5156
### $jpegQuality
52-
Affects the quality of saved JPEG files.
57+
Affects the quality of saved JPEG files. This is specified as a percentage, i.e. 100 being the best.
58+
```
59+
$jpegQuality = 85;
60+
```
5361

5462
### $passPhrase
5563
Pass phrase for accessing administion functions when implemented - this should be changed to something else.
64+
```
65+
$passPhrase = 'secret_passphrase';
66+
```

0 commit comments

Comments
 (0)