Skip to content

Commit a2eb49d

Browse files
committed
Add issue template and update readme
1 parent cbfc42b commit a2eb49d

File tree

2 files changed

+72
-2
lines changed

2 files changed

+72
-2
lines changed

ISSUE_TEMPLATE.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
**NOTE**: Please test in a least two browsers (i.e. Chrome and Firefox). This
2+
helps with diagnosing problems quicker.
3+
4+
> Please confirm the following:
5+
6+
- [ ] I have read the [README](https://github.com/web-push-libs/web-push-php) entirely
7+
- [ ] I have verified in the [issues](https://github.com/web-push-libs/web-push-php/issues) that my problem hasn't already been resolved
8+
9+
# Setup
10+
11+
> Please provide the following details, the more info you can provide the
12+
> better.
13+
14+
* *Operating System*: <Linux | Windows | OS X>
15+
* *PHP Version*: <5.6 | 7.0 | ...>
16+
* *web-push-php Version*: <1.0.0>
17+
18+
> Please check that you have installed and enabled these PHP extensions :
19+
20+
- [ ] gmp
21+
- [ ] mbstring
22+
- [ ] curl
23+
- [ ] openssl
24+
25+
> Please select any browsers that you are experiencing problems with:
26+
27+
- [ ] Chrome
28+
- [ ] Firefox
29+
- [ ] Opera for Android
30+
- [ ] Samsung Internet Browser
31+
- [ ] Other
32+
33+
> Please list the browsers you are have tested this, including the version
34+
> of the browser (i.e. Chrome Beta, Firefox Beta etc).
35+
36+
# Problem
37+
38+
> Please explain what behaviour you are seeing.
39+
40+
# Expected
41+
42+
> Please explain what you expected to happen
43+
44+
# Features Used
45+
46+
- [ ] VAPID Support
47+
- [ ] GCM API Key
48+
- [ ] Sending with Payload
49+
50+
# Example / Reproduce Case
51+
52+
> Please provide a code sample that reproduces the issue. If there is a
53+
> repository that reproduces the issue please put the link here.
54+
55+
# Other
56+
57+
> Please put any remaining notes here.

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/d60e8eea-aea1-4739-8ce0-a3c3c12c6ccf/mini.png)](https://insight.sensiolabs.com/projects/d60e8eea-aea1-4739-8ce0-a3c3c12c6ccf)
66

77
## Installation
8+
Use [composer](https://getcomposer.org/) to download and install the library and its dependencies.
9+
810
`composer require minishlink/web-push`
911

1012
## Usage
@@ -14,7 +16,8 @@ As it is standardized, you don't have to worry about what server type it relies
1416

1517
Notifications with payloads are supported with this library on Firefox 46+ and Chrome 50+.
1618

17-
You'll need at least PHP 5.6, and PHP 7.1 is recommended for much better performance.
19+
You'll need at least PHP 5.6 with the following extensions enabled: gmp, mbstring, curl, openssl.
20+
PHP 7.1 is recommended for much better performance.
1821

1922
```php
2023
<?php
@@ -249,14 +252,24 @@ local public and private keys and compute the shared secret.
249252
Then, if you have a PHP >= 7.1, WebPush uses `openssl` in order to encrypt the payload with the encryption key.
250253
Otherwise, if you have PHP < 7.1, it uses [Spomky-Labs/php-aes-gcm](https://github.com/Spomky-Labs/php-aes-gcm), which is slower.
251254

252-
### How to solve "SSL certificate problem: unable to get local issuer certificate" ?
255+
### How to solve "SSL certificate problem: unable to get local issuer certificate"?
253256
Your installation lacks some certificates.
254257

255258
1. Download [cacert.pem](http://curl.haxx.se/ca/cacert.pem).
256259
2. Edit your `php.ini`: after `[curl]`, type `curl.cainfo = /path/to/cacert.pem`.
257260

258261
You can also force using a client without peer verification.
259262

263+
### How to solve "Bad key encryption key length"?
264+
Disable `mbstring.func_overload` in your `php.ini`.
265+
266+
### How to solve "Class 'Minishlink\WebPush\WebPush' not found"
267+
Make sure to require Composer's [autoloader](https://getcomposer.org/doc/01-basic-usage.md#autoloading).
268+
269+
```php
270+
require __DIR__ . '/path/to/vendor/autoload.php';
271+
```
272+
260273
### I lost my VAPID keys!
261274
See [issue #58](https://github.com/web-push-libs/web-push-php/issues/58).
262275

0 commit comments

Comments
 (0)