Skip to content

Commit

Permalink
Updating README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Fredrik Liljegren committed Oct 28, 2014
1 parent 23041b2 commit a779bbe
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 12 deletions.
21 changes: 17 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
install:
composer.phar install
install: composer.phar
./composer.phar install

update:
composer.phar update
./composer.phar update

test:
test: vendor/bin/phpunit build
./vendor/bin/phpunit --strict

composer.phar:
curl -s http://getcomposer.org/installer | php

vendor/bin/phpunit: install

build:
mkdir build

clean:
rm composer.phar
rm -r vendor
rm -r build
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@ of Connections and check them periodically for new data, send something to them
process handling one connection. But, I have no use for that right now. (Actually, I would
suggest a language with better asynchronous handling than PHP for that.)

Install
-------
```bash
# Install composer
curl -s http://getcomposer.org/installer | php
Installing
----------

# Generate vendor/autload.php
php composer.phar install --no-dev
Preferred way to install is with [Composer](https://getcomposer.org/).

```
Just add

"require": {
"textalk/websocket": "1.0.*"
}

in your projects composer.json.

Client usage:
-------------
Expand All @@ -41,3 +43,22 @@ $client->send("Hello WebSocket.org!");

echo $client->receive(); // Will output 'Hello WebSocket.org!'
```

Developer install
-----------------

Development depends on php, php-curl and php-xdebug.

```bash
# Will get composer, install dependencies and run tests
make test
```

Changelog
---------

1.0.0

* Release as production ready.
* Adding option to set/override headers.
* Supporting basic authentication from user:pass in URL.

0 comments on commit a779bbe

Please sign in to comment.