Skip to content

Commit 0c9056a

Browse files
committed
Merge pull request #2 from juukie/fix-typos
Fix typos Thanks @juukie for fixing my horrid typos! Cheers!
2 parents 04ab1b2 + c23347b commit 0c9056a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ If you want to really absorb the power of the capabilities of this module then c
99
http://highscalability.com/blog/2014/4/28/how-disqus-went-realtime-with-165k-messages-per-second-and-l.html
1010

1111
# How does this driver work?
12-
Once you setup all your routes for the pub/sub requests to the HTTP routes in in the `location` directives for *Nginx*, then you'll be able to quickly open a socket on your client use the **pushstream.js** and push your broadcasts out using websocket or long-polling.
12+
Once you setup all your routes for the pub/sub requests to the HTTP routes in the `location` directives for *Nginx*, then you'll be able to quickly open a socket on your client use the **pushstream.js** and push your broadcasts out using websocket or long-polling.
1313

1414
The *pub/sub* requests are internally called by the [GuzzleHttp](http://guzzle.readthedocs.org/en/latest/) package. The `broadcasting.php` config file will use the **pushstream** driver where you can control the HTTP requests to the to your pub/sub endpoints.
1515

16-
You can lock down your pub/sub nginx endpoints using the [Access Key Module](http://wiki.nginx.org/HttpAccessKeyModule). Here you can configure the key
16+
You can lock down your pub/sub nginx endpoints using the [Access Key Module](http://wiki.nginx.org/HttpAccessKeyModule). Here you can configure the key.
1717

1818
## Requirements
1919

20-
* **HTTP Pushstream Module:** You must compile the Nginx HTTP Pushstream module. Here are some instructions on how to do it here for the module itself on github:
20+
* **HTTP Pushstream Module:** You must compile the Nginx HTTP Pushstream module. Here are some instructions on how to do it here for the module itself on github:
2121
* [Github readme](https://github.com/wandenberg/nginx-push-stream-module#installation)
2222
* [Nginx module site](http://wiki.nginx.org/HttpPushStreamModule#instalation)
2323
* [I have made an Ubuntu install script](scripts/install_nginx_pushstream_module.sh)
2424

25-
* **Acces Key Module** Also, if you want to use the `access_key` feature to the routes for the pub/sub then please also install the [Access Key Module](http://wiki.nginx.org/HttpAccessKeyModule)
25+
* **Acces Key Module** Also, if you want to use the `access_key` feature to the routes for the pub/sub then please also install the [Access Key Module](http://wiki.nginx.org/HttpAccessKeyModule).
2626

2727

2828
## Installation
2929

3030
1. Do a composer require get this package: `composer require cmosguy/laravel-http-pushstream-broadcaster`
3131

32-
2. Next, go into your `config/broadcasting.php` file and add and adjust the following lines accordingly. `base_url` refers to websocket root for your HTTP requests pub/sub routes:
32+
2. Next, go into your `config/broadcasting.php` file and add the following lines accordingly. `base_url` refers to websocket root for your HTTP requests pub/sub routes:
3333

3434
'default' => pushstream,
3535

@@ -48,7 +48,7 @@ You can lock down your pub/sub nginx endpoints using the [Access Key Module](htt
4848

4949
push_stream_shared_memory_size 32M;
5050

51-
2. Edit your config file for your routes in the `server {` section. Obviously, you need to understand and modify the items below. The folling config information is just meant to get you started. If you want a more thorough config check out [this](https://gist.github.com/dctrwatson/0b3b52050254e273ff11#file-nginx-v):
51+
2. Edit your config file for your routes in the `server {` section. Obviously, you need to understand and modify the items below. The following config information is just meant to get you started. If you want a more thorough config check out [this](https://gist.github.com/dctrwatson/0b3b52050254e273ff11#file-nginx-v):
5252

5353
location /channels-stats {
5454
# activate channels statistics mode for this location
@@ -162,16 +162,16 @@ Please download the **pushstream.js** from either following locations:
162162
At this time the only way to get more information from about the module and the capabilities is directly from the github repository, so do some reading here:
163163

164164
* https://github.com/wandenberg/nginx-push-stream-module
165-
* See how the pushstream.js example works here: http://www.nginxpushstream.com/chat.html
166-
* Also read more about the pushstream.js here: https://github.com/wandenberg/nginx-push-stream-module/blob/master/docs/examples/websocket.textile#websocket-
165+
* See how the pushstream.js example works here: http://www.nginxpushstream.com/chat.html
166+
* Also read more about the pushstream.js here: https://github.com/wandenberg/nginx-push-stream-module/blob/master/docs/examples/websocket.textile#websocket-
167167

168168
169169
# Disclaimer
170170

171-
This is by no means the only want to go about how this should work. You need to understand what all the options do and there is definitely a a
171+
This is by no means the only way to go about how this should work. You need to understand what all the options do and there is definitely a a
172172

173173
# Help
174-
Please help me with updating this documentation. If it does not make sense or if you see something stupid let me know. Also, if there is a way to make this extend further and make it more flexible for othher's pleaes offer a PR and can improve upon these.
174+
Please help me with updating this documentation. If it does not make sense or if you see something stupid let me know. Also, if there is a way to make this extend further and make it more flexible for others, please submit a PR to improve upon these.
175175

176176

177177

0 commit comments

Comments
 (0)