5
5
<!-- TOC -->
6
6
* [ 1. Purpose] ( #1-purpose )
7
7
* [ 2. Example] ( #2-example )
8
- * [ 3. Usage] ( #3-usage )
9
- * [ 4. License] ( #4-license )
8
+ * [ 3. Requirements] ( #3-requirements )
9
+ * [ 4. Installation] ( #4-installation )
10
+ * [ 5. Usage] ( #5-usage )
11
+ * [ 6. License] ( #6-license )
10
12
<!-- TOC -->
11
13
12
14
## 1. Purpose
@@ -24,7 +26,37 @@ client if this is supported by the game.
24
26
25
27
[ ![ Example Signature] [ 5 ]] [ 6 ]
26
28
27
- ## 3. Usage
29
+ ## 3. Requirements
30
+
31
+ * PHP 8.x
32
+ * ` mbstring ` extension for handling international characters and emojis
33
+ * ` GD ` extension for rendering the images
34
+ * [ Composer] [ 7 ]
35
+ * basic knowledge of executing shell commands on a server
36
+
37
+ ** Note:** The only ** officially** supported way to install this package is via
38
+ Composer. However, it is theoretically possible to install PHP 8 and Composer
39
+ on a local computer, run the installation there and then upload the ` vendor `
40
+ folder created by Composer to the server, in case shell access is not available.
41
+
42
+ ## 4. Installation
43
+
44
+ ** Important:** This package uses the [ Composer] [ 7 ] dependency manager for
45
+ PHP to check system requirements and to install package dependencies. Please
46
+ make sure it is installed before trying to use this package.
47
+
48
+ The following example assumes that your web server is running under the user
49
+ account ` www-data ` , that ` composer ` is installed into the system ` $PATH ` , and
50
+ that you have a working ` sudo ` setup to run shell commands as a different user.
51
+
52
+ In this case, you simply have to run this command within the same directory
53
+ which contains this ` README.md ` on your server:
54
+
55
+ ``` bash
56
+ sudo -u www-data composer install
57
+ ```
58
+
59
+ ## 5. Usage
28
60
29
61
A basic approach at using this package could look like this:
30
62
@@ -62,7 +94,7 @@ $signature->getLinkTarget();
62
94
The example above should be mostly self-explanatory.
63
95
64
96
The ` API ` class must be initialized with a personalized API key. You can obtain
65
- your API key from the [ Steam developer website] [ 7 ] .
97
+ your API key from the [ Steam developer website] [ 8 ] .
66
98
67
99
The ` API ` class is a very limited implementation of the Steam Web-API and is not
68
100
supposed to be used directly, except for one method:
@@ -90,7 +122,7 @@ The `Signature` class provides two public methods:
90
122
An example implementation of this script can be found in the [ ` src/www/ ` ] ( src/www )
91
123
folder.
92
124
93
- ## 4 . License
125
+ ## 6 . License
94
126
95
127
See [ LICENSE.txt] ( LICENSE.txt ) for full license details.
96
128
@@ -101,4 +133,5 @@ See [LICENSE.txt](LICENSE.txt) for full license details.
101
133
[ 4 ] : https://partner.steamgames.com/documentation/community_data
102
134
[ 5 ] : src/data/images/example.png
103
135
[ 6 ] : https://steamcommunity.com/id/randomhosttv
104
- [ 7 ] : http://steamcommunity.com/dev
136
+ [ 7 ] : https://getcomposer.org
137
+ [ 8 ] : http://steamcommunity.com/dev
0 commit comments