Skip to content

Commit dc46d9c

Browse files
committed
Update README
1 parent 1f8805f commit dc46d9c

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The PHP SASL Authentification Library.
66
[![Latest Stable Version](https://poser.pugx.org/fabiang/sasl/v/stable.svg)](https://packagist.org/packages/fabiang/sasl)
77
[![Total Downloads](https://poser.pugx.org/fabiang/sasl/downloads.svg)](https://packagist.org/packages/fabiang/sasl)
88
[![License](https://poser.pugx.org/fabiang/sasl/license.svg)](https://packagist.org/packages/fabiang/sasl)
9-
[![CI](https://github.com/fabiang/sasl/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/fabiang/sasl/actions/workflows/ci.yml)
9+
[![CI](https://github.com/fabiang/sasl/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/fabiang/sasl/actions/workflows/ci.yml)
1010
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fabiang/sasl/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/fabiang/sasl/?branch=develop)
1111
[![Code Coverage](https://scrutinizer-ci.com/g/fabiang/sasl/badges/coverage.png?b=develop)](https://scrutinizer-ci.com/g/fabiang/sasl/?branch=develop)
1212

@@ -74,6 +74,8 @@ If the method returns false you should disconnect.
7474
To enable [downgrade protection for SCRAM](https://xmpp.org/extensions/xep-0474.html), you'll need to pass
7575
the allowed authentication mechanisms and channel-binding types via options to the factory:
7676

77+
**Note**: Channel-binding is currently not supported due to limitations of PHP.
78+
7779
```php
7880
$mechanism = $factory->factory('SCRAM-SHA-1', array(
7981
'authcid' => 'username',
@@ -119,8 +121,6 @@ Run the unit tests:
119121

120122
The integration tests verify the authentication methods against an Ejabberd and Dovecot server.
121123

122-
### Docker Compose
123-
124124
To launch the servers you can use the provided Docker Compose file.
125125
Just [install Docker](https://www.docker.com/get-started/) and run:
126126

@@ -130,8 +130,6 @@ docker compose up -d
130130

131131
**Note:** ejabberd takes up to *twenty minutes* to start.
132132

133-
### RUN
134-
135133
Now you can run the integration tests:
136134

137135
```

0 commit comments

Comments
 (0)