Fix readme headers, update apigen with 0.4

This commit is contained in:
Chris Boden 2017-09-09 16:59:25 -04:00
parent 4ac1f914f3
commit 829af203b2
2 changed files with 14 additions and 9 deletions

View File

@ -29,9 +29,14 @@ profile:
killall php killall php
apidocs: apidocs:
apigen --title Ratchet -d reports/api -s src/ \ apigen --title Ratchet -d reports/api \
-s vendor/react \ -s src/ \
-s vendor/guzzle \ -s vendor/ratchet/rfc6455/src \
-s vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Session \ -s vendor/react/event-loop/src \
-s vendor/symfony/routing/Symfony/Component/Routing \ -s vendor/react/socket/src \
-s vendor/evenement/evenement/src/Evenement -s vendor/react/stream/src \
-s vendor/psr/http-message/src \
-s vendor/symfony/http-foundation/Session \
-s vendor/symfony/routing \
-s vendor/evenement/evenement/src/Evenement \
--exclude=vendor/symfony/routing/Tests \

View File

@ -1,4 +1,4 @@
#Ratchet # Ratchet
[![Build Status](https://secure.travis-ci.org/ratchetphp/Ratchet.png?branch=master)](http://travis-ci.org/ratchetphp/Ratchet) [![Build Status](https://secure.travis-ci.org/ratchetphp/Ratchet.png?branch=master)](http://travis-ci.org/ratchetphp/Ratchet)
[![Autobahn Testsuite](https://img.shields.io/badge/Autobahn-passing-brightgreen.svg)](http://socketo.me/reports/ab/index.html) [![Autobahn Testsuite](https://img.shields.io/badge/Autobahn-passing-brightgreen.svg)](http://socketo.me/reports/ab/index.html)
@ -7,7 +7,7 @@
A PHP library for asynchronously serving WebSockets. A PHP library for asynchronously serving WebSockets.
Build up your application through simple interfaces and re-use your application without changing any of its code just by combining different components. Build up your application through simple interfaces and re-use your application without changing any of its code just by combining different components.
##Requirements ## Requirements
Shell access is required and root access is recommended. Shell access is required and root access is recommended.
To avoid proxy/firewall blockage it's recommended WebSockets are requested on port 80 or 443 (SSL), which requires root access. To avoid proxy/firewall blockage it's recommended WebSockets are requested on port 80 or 443 (SSL), which requires root access.
@ -24,7 +24,7 @@ Need help? Have a question? Want to provide feedback? Write a message on the
--- ---
###A quick example ### A quick example
```php ```php
<?php <?php