Skip to content

Commit 0ca5bc0

Browse files
committed
Rename master branch to 0.4.x and add installation instructions
1 parent 5a4461a commit 0ca5bc0

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ratchet
22

3-
[![GitHub Actions][GA Image]][GA Link]
3+
[![CI status](https://github.com/ratchetphp/Ratchet/actions/workflows/ci.yml/badge.svg)](https://github.com/ratchetphp/Ratchet/actions)
44
[![Autobahn Testsuite](https://img.shields.io/badge/Autobahn-passing-brightgreen.svg)](http://socketo.me/reports/ab/index.html)
55
[![Latest Stable Version](https://poser.pugx.org/cboden/ratchet/v/stable.png)](https://packagist.org/packages/cboden/ratchet)
66

@@ -87,6 +87,25 @@ class MyChat implements MessageComponentInterface {
8787
conn.onopen = function(e) { conn.send('Hello Me!'); };
8888
```
8989

90-
[GA Image]: https://github.com/ratchetphp/Ratchet/workflows/CI/badge.svg
90+
## Install
9191

92-
[GA Link]: https://github.com/ratchetphp/Ratchet/actions?query=workflow%3A%22CI%22+branch%3Amaster
92+
The recommended way to install this library is [through Composer](https://getcomposer.org/).
93+
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
94+
95+
This will install the latest supported version:
96+
97+
```bash
98+
composer require cboden/ratchet:^0.4.4
99+
```
100+
101+
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
102+
103+
This project aims to run on any platform and thus does not require any PHP
104+
extensions and supports running on legacy PHP 5.4 through PHP 7.4+ with limited support for PHP 8+.
105+
It's *highly recommended to use the latest supported PHP version* for this project.
106+
107+
See above note about [Reviving Ratchet](#reviving-ratchet) for newer PHP support.
108+
109+
## License
110+
111+
MIT, see [LICENSE file](LICENSE).

0 commit comments

Comments
 (0)