Skip to content

Commit 1f58b27

Browse files
authored
Remove outdated info
1 parent 7ac8365 commit 1f58b27

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
> Web Push library for PHP
33
44
[![Build Status](https://github.com/web-push-libs/web-push-php/actions/workflows/tests.yml/badge.svg)](https://github.com/web-push-libs/web-push-php/actions/workflows/tests.yml)
5-
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/d60e8eea-aea1-4739-8ce0-a3c3c12c6ccf/mini.png)](https://insight.sensiolabs.com/projects/d60e8eea-aea1-4739-8ce0-a3c3c12c6ccf)
65

76
WebPush can be used to send notifications to endpoints which server delivers Web Push notifications as described in
8-
the [Web Push protocol](https://tools.ietf.org/html/draft-thomson-webpush-protocol-00).
7+
the [Web Push protocol](https://datatracker.ietf.org/doc/html/rfc8030).
98
As it is standardized, you don't have to worry about what server type it relies on.
109

1110
## Requirements
@@ -23,6 +22,8 @@ There is no support and maintenance for older PHP versions, however you are free
2322
- PHP 7.2: `v6.x`
2423
- PHP 7.3 7.4: `v7.x`
2524

25+
This README is only compatible with the latest version. Each version of the library has a git tag where the corresponding README can be read.
26+
2627
## Installation
2728
Use [composer](https://getcomposer.org/) to download and install the library and its dependencies.
2829

@@ -165,7 +166,7 @@ $webPush->setReuseVAPIDHeaders(true);
165166

166167
### Notifications and default options
167168
Each notification can have a specific Time To Live, urgency, and topic.
168-
The WebPush standard states that `urgency` is optional but some users reports that Safari throws errors when they are not specified. This might be fixed in the future.
169+
The WebPush standard states that `urgency` is optional but some users reports that Safari throws errors when it is not specified. This might be fixed in the future.
169170
You can change the default options with `setDefaultOptions()` or in the constructor:
170171

171172
```php
@@ -313,9 +314,6 @@ The following are available:
313314

314315
Feel free to add your own!
315316

316-
### Is the API stable?
317-
Not until the [Push API spec](http://www.w3.org/TR/push-api/) is finished.
318-
319317
### What about security?
320318
Payload is encrypted according to the [Message Encryption for Web Push](https://tools.ietf.org/html/draft-ietf-webpush-encryption-01) standard,
321319
using the user public key and authentication secret that you can get by following the [Web Push API](http://www.w3.org/TR/push-api/) specification.
@@ -325,10 +323,9 @@ Internally, WebPush uses the [WebToken](https://github.com/web-token) framework
325323
### How do I scale?
326324
Here are some ideas:
327325

328-
1. Upgrade to PHP 7.3
329-
2. Make sure MultiCurl is available on your server
330-
3. Find the right balance for your needs between security and performance (see above)
331-
4. Find the right batch size (set it in `defaultOptions` or as parameter to `flush()`)
326+
1. Make sure MultiCurl is available on your server
327+
2. Find the right balance for your needs between security and performance (see above)
328+
3. Find the right batch size (set it in `defaultOptions` or as parameter to `flush()`)
332329

333330
### How to solve "SSL certificate problem: unable to get local issuer certificate"?
334331
Your installation lacks some certificates.
@@ -338,9 +335,6 @@ Your installation lacks some certificates.
338335

339336
You can also force using a client without peer verification.
340337

341-
### How to solve "Bad key encryption key length" or "Unsupported key type"?
342-
Disable `mbstring.func_overload` in your `php.ini`.
343-
344338
### How to solve "Class 'Minishlink\WebPush\WebPush' not found"
345339
Make sure to require Composer's [autoloader](https://getcomposer.org/doc/01-basic-usage.md#autoloading).
346340

@@ -367,6 +361,3 @@ See [CONTRIBUTING.md](https://github.com/Minishlink/web-push/blob/master/CONTRIB
367361

368362
## License
369363
[MIT](https://github.com/Minishlink/web-push/blob/master/LICENSE)
370-
371-
## Sponsors
372-
Thanks to [JetBrains](https://www.jetbrains.com/) for supporting the project through sponsoring some [All Products Packs](https://www.jetbrains.com/products.html) within their [Free Open Source License](https://www.jetbrains.com/buy/opensource/) program.

0 commit comments

Comments
 (0)