Skip to content
This repository has been archived by the owner on Mar 6, 2019. It is now read-only.

Commit

Permalink
Link to L5
Browse files Browse the repository at this point in the history
  • Loading branch information
CupOfTea696 committed Apr 26, 2015
1 parent fe8e8ca commit d2aeba7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
# TwoStream
### Two-way communication between Laravel and your Client

TwoStream is a WebSocket server for Laravel 5, built upon [Ratchet](http://socketo.me). This package is currently in **beta** stage and not complete. The most important functionality has been built but could use some more testing.
TwoStream is a WebSocket server for [Laravel 5][l5], built upon [Ratchet](http://socketo.me). This package is currently in **beta** stage and not complete. The most important functionality has been built but could use some more testing.

I am currently working on the Documentation, so that's coming soon. For now, the info below will have to do.

[API Explorer](http://cupoftea696.github.io/TwoStream/docs/api/)

TwoStream is Laravel 5 only.
TwoStream is [Laravel 5][l5] only.

## Completed:
- ServiceProvider and Facades, add `'CupOfTea\TwoStream\TwoStreamServiceProvider',` to your providers, and `'TwoStream' => 'CupOfTea\TwoStream\Facades\TwoStream',` and `'WsRoute' => 'CupOfTea\TwoStream\Facades\WsRoute',` to your aliases in `config/app.php`
Expand All @@ -26,6 +26,7 @@ TwoStream is Laravel 5 only.
- Online Documentation

### Acknowledgements
TwoStream is heavily based on [Latchet][latchet]. Some of the internal workings and public API is entirely different, other parts are near copy-pasted from the original code. The main difference between TwoStream and [Latchet][latchet] is (or will be) Laravel 5 support and read-only access to Session data. If you are using Laravel 4, please do go and use [Latchet][latchet] since it is pretty good. (Although the creator claims it's not even an alhpa version. Believe me, it is.) If you use Laravel 5 however, feel free to start testing this out and contribute.
TwoStream is heavily based on [Latchet][latchet]. Some of the internal workings and public API is entirely different, other parts are near copy-pasted from the original code. The main difference between TwoStream and [Latchet][latchet] is [Laravel 5][l5] support and read-only access to Session data. If you are using Laravel 4, please do go and use [Latchet][latchet] since it is pretty good. (Although the creator claims it's not even an alpha version. Believe me, it is.) If you use [Laravel 5][l5] however, feel free to start testing this out and contribute.

[l5]: https://github.com/laravel/framework/ "Laravel 5"
[latchet]: https://github.com/sidneywidmer/Latchet "Latchet (L4 Package)"

0 comments on commit d2aeba7

Please sign in to comment.