README.md in faye-authentication-0.3.0 vs README.md in faye-authentication-0.4.0
- old
+ new
@@ -36,9 +36,21 @@
$ gem install faye-authentication
## Usage
+### Channels requiring authentication
+
+All channels require authentication, except channels beginning by ``/public/``
+
+However, globbing, even on ``/public/`` channels will require authentication.
+
+Example :
+
+- ``/public/foo`` does not require authentication
+- ``/public/bar/*`` requires authentication
+
+
### Authentication endpoint requirements
The endpoint will receive a POST request, and shall return a JSON hash with a ``signature`` key.
The parameters sent to the endpoint are the following :