Skip to content

Commit

Permalink
Update README file (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
antonkomarev authored Oct 11, 2023
1 parent 4b7d272 commit c08c341
Showing 1 changed file with 31 additions and 29 deletions.
60 changes: 31 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<p align="center">
<a href="https://github.com/cybercog/php-pushwoosh/releases"><img src="https://img.shields.io/github/release/cybercog/php-pushwoosh.svg?style=flat-square" alt="Releases"></a>
<a href="https://github.com/cybercog/php-pushwoosh/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/cybercog/php-pushwoosh/tests.yml?style=flat-square" alt="Build"></a>
<a href="https://github.com/cybercog/php-pushwoosh/blob/master/LICENSE"><img src="https://img.shields.io/github/license/cybercog/php-pushwoosh.svg?style=flat-square" alt="License"></a>
</p>

## 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
Expand All @@ -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).
<a href="https://cybercog.su"><img src="https://cloud.githubusercontent.com/assets/1849174/18418932/e9edb390-7860-11e6-8a43-aa3fad524664.png" alt="CyberCog"></a>

Visit also http://gomoob.github.io to discover more Open Source softwares we develop.
[Anton Komarev]: https://komarev.com
[CyberCog]: https://cybercog.su

0 comments on commit c08c341

Please sign in to comment.