diff --git a/README.md b/README.md index 4c058dd..1804238 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,26 @@ -# php-pushwoosh +# PHP Pushwoosh -> A PHP Library to easily send push notifications with the Pushwoosh REST Web Services. +A PHP Library to easily send PUSH notifications with the Pushwoosh REST Web Services. -[![Total Downloads](https://img.shields.io/packagist/dt/cybercog/php-pushwoosh.svg?style=flat-square)](https://packagist.org/packages/cybercog/php-pushwoosh) -[![Latest Stable Version](https://img.shields.io/packagist/v/cybercog/php-pushwoosh.svg?style=flat-square)](https://packagist.org/packages/cybercog/php-pushwoosh) -[![Build Status](https://img.shields.io/travis/cybercog/php-pushwoosh.svg?style=flat-square)](https://travis-ci.org/cybercog/php-pushwoosh) -[![Coverage](https://img.shields.io/coveralls/cybercog/php-pushwoosh.svg?style=flat-square)](https://coveralls.io/r/cybercog/php-pushwoosh?branch=master) -[![Code Climate](https://img.shields.io/codeclimate/github/cybercog/php-pushwoosh.svg?style=flat-square)](https://codeclimate.com/github/cybercog/php-pushwoosh) -[![License](https://img.shields.io/packagist/l/cybercog/php-pushwoosh.svg?style=flat-square)](https://packagist.org/packages/cybercog/php-pushwoosh) +Forked [gomoob/php-pushwoosh](https://github.com/gomoob/php-pushwoosh) because original project stalled. -## First sample, creating a Pushwoosh message +
+ +## Installation + +Pull in the package through Composer. + +```shell script +composer require cybercog/php-pushwoosh +``` + +## Usage + +Sample of creating and sending the Pushwoosh message. ```php // Create a Pushwoosh client @@ -24,36 +35,27 @@ $request = CreateMessageRequest::create() // Call the REST Web Service $response = $pushwoosh->createMessage($request); -// Check if its ok -if($response->isOk()) { +// Check if it's ok +if ($response->isOk()) { print 'Great, my message has been sent !'; } else { - print 'Oups, the sent failed :-('; + print 'Oops, the sent failed :-('; print 'Status code : ' . $response->getStatusCode(); print 'Status message : ' . $response->getStatusMessage(); } ``` -Easy, isn't it ? - -## Documentation - - * [Documentation](http://gomoob.github.io/php-pushwoosh) - * [How to Contribute](http://gomoob.github.io/php-pushwoosh/contribute.html) +## License -## Framework Integrations - - **Laravel** - https://github.com/schimpanz/Laravel-Pushwoosh - - **Symfony 2** - https://github.com/Prezent/pushwoosh-bundle +- `PHP Pushwoosh` package is open-sourced software licensed under the [MIT license](LICENSE) by [Anton Komarev]. -If you have integrated php-pushwoosh into a popular PHP framework let us know ! +## About CyberCog -## About Gomoob +[CyberCog] is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion. -At [Gomoob](https://www.gomoob.com) we build high quality software with awesome Open Source frameworks everyday. Would -you like to start your next project with us? That's great! Give us a call or send us an email and we will get back to -you as soon as possible ! +- [Follow us on Twitter](https://twitter.com/cybercog) -You can contact us by email at [contact@gomoob.com](mailto:contact@gomoob.com) or by phone number -[(+33) 6 85 12 81 26](tel:+33685128126) or [(+33) 6 28 35 04 49](tel:+33685128126). + -Visit also http://gomoob.github.io to discover more Open Source softwares we develop. +[Anton Komarev]: https://komarev.com +[CyberCog]: https://cybercog.su