Skip to content

Commit ad9d0e2

Browse files
authored
doc: Add a doc entry for downloading the PHAR from GitHub (#885)
1 parent 7dbccc0 commit ad9d0e2

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ potentially very difficult to debug due to dissimilar or unsupported package ver
3030

3131
- [Installation](docs/installation.md#installation)
3232
- [Phive](docs/installation.md#phive)
33-
- [PHAR](docs/installation.md#phar)
3433
- [Composer](docs/installation.md#composer)
34+
- [GitHub](docs/installation.md#github)
3535
- [Usage](#usage)
3636
- [Configuration](docs/configuration.md#configuration)
3737
- [Prefix](docs/configuration.md#prefix)

docs/installation.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,35 @@ $ composer bin php-scoper require --dev humbug/php-scoper
4545
$ vendor/bin/php-scoper
4646
```
4747

48+
## GitHub
49+
50+
You may download the Box PHAR directly from the [GitHub release][releases] directly.
51+
You should however beware that it is not as secure as downloading it from the other mediums.
52+
Hence, it is recommended to check the signature when doing so:
53+
54+
```shell
55+
# Do adjust the URL based on the latest release
56+
wget -O box.phar "https://github.com/humbug/php-scoper/releases/download/0.18.4/php-scoper.phar"
57+
wget -O box.phar.asc "https://github.com/humbug/php-scoper/releases/download/0.18.4/php-scoper.phar.asc"
58+
59+
# Check that the signature matches
60+
gpg --verify php-scoper.phar.asc php-scoper.phar
61+
62+
# Check the issuer (the ID can also be found from the previous command)
63+
gpg --keyserver hkps://keys.openpgp.org --recv-keys 74A754C9778AA03AA451D1C1A000F927D67184EE
64+
65+
rm php-scoper.phar.asc
66+
chmod +x php-scoper.phar
67+
```
68+
4869

4970
<br />
5071
<hr />
5172

5273
« [Table of Contents](../README.md#table-of-contents)[Configuration](configuration.md#configuration) »
5374

5475

55-
[releases]: https://github.com/humbug/php-scoper/releases
5676
[composer]: https://getcomposer.org
5777
[bamarni/composer-bin-plugin]: https://github.com/bamarni/composer-bin-plugin
5878
[phive]: https://github.com/phar-io/phive
79+
[releases]: https://github.com/humbug/php-scoper/releases

0 commit comments

Comments
 (0)