|
1 | | -[](https://travis-ci.org/ker0x/fcm) |
2 | | -[](https://coveralls.io/github/ker0x/fcm) |
3 | | -[](https://scrutinizer-ci.com/g/ker0x/fcm/) |
4 | | -[](https://packagist.org/packages/ker0x/fcm) |
5 | | -[](https://packagist.org/packages/ker0x/fcm) |
6 | | -[](http://fcm.readthedocs.org/en/latest/?badge=latest) |
7 | | -[](https://packagist.org/packages/ker0x/fcm) |
8 | | - |
9 | | -# FCM PHP library |
| 1 | +<div align="center"> |
| 2 | + <a href="https://travis-ci.org/ker0x/fcm" title="Build"> |
| 3 | + <img src="https://img.shields.io/travis/ker0x/fcm.svg?style=for-the-badge" alt="Build"> |
| 4 | + </a> |
| 5 | + <a href="https://scrutinizer-ci.com/g/ker0x/fcm/" title="Coverage"> |
| 6 | + <img src="https://img.shields.io/scrutinizer/coverage/g/ker0x/fcm.svg?style=for-the-badge" alt="Coverage"> |
| 7 | + </a> |
| 8 | + <a href="https://scrutinizer-ci.com/g/ker0x/fcm/" title="Code Quality"> |
| 9 | + <img src="https://img.shields.io/scrutinizer/g/ker0x/fcm.svg?style=for-the-badge" alt="Code Quality"> |
| 10 | + </a> |
| 11 | + <a href="https://php.net" title="PHP Version"> |
| 12 | + <img src="https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=for-the-badge" alt="PHP Version"> |
| 13 | + </a> |
| 14 | + <a href="https://packagist.org/packages/kerox/fcm" title="Downloads"> |
| 15 | + <img src="https://img.shields.io/packagist/dt/kerox/fcm.svg?style=for-the-badge" alt="Downloads"> |
| 16 | + </a> |
| 17 | + <a href="https://packagist.org/packages/kerox/fcm" title="Latest Stable Version"> |
| 18 | + <img src="https://img.shields.io/packagist/v/kerox/fcm.svg?style=for-the-badge" alt="Latest Stable Version"> |
| 19 | + </a> |
| 20 | + <a href="https://packagist.org/packages/kerox/fcm" title="License"> |
| 21 | + <img src="https://img.shields.io/packagist/l/kerox/fcm.svg?style=for-the-badge" alt="License"> |
| 22 | + </a> |
| 23 | +</div> |
| 24 | + |
| 25 | +# Fcm |
10 | 26 |
|
11 | 27 | A PHP libray to send push notification with [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) |
12 | 28 |
|
13 | | -> Note: This is a portage as a standalone library, with some enhancements, of the great plugin [Laravel-FCM](https://github.com/brozot/Laravel-FCM) by [Nicolas Brosy](https://github.com/brozot) |
14 | | -
|
15 | | -## Requirements |
| 29 | +## Warning |
16 | 30 |
|
17 | | -* PHP >= 7.0 |
| 31 | +Version `2.x` of this library is a full rewrite to be compliant with [HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages). If you are on Legacy HTTP API, then you should consider using version `1.x` |
18 | 32 |
|
19 | | -## Documentation |
| 33 | +## Installation |
20 | 34 |
|
21 | | -The documentation is available [here](http://fcm.readthedocs.org/en/latest/) |
| 35 | +You can install Fcm using Composer: |
22 | 36 |
|
23 | | -## License |
| 37 | +``` |
| 38 | +composer require kerox/fcm |
| 39 | +``` |
24 | 40 |
|
25 | | -The MIT License (MIT) |
| 41 | +You will then need to: |
| 42 | +* run `composer install` to get these dependencies added to your vendor directory |
| 43 | +* add the autoloader to your application with this line: `require('vendor/autoload.php');` |
26 | 44 |
|
27 | | -Copyright (c) 2016 Romain Monteil |
28 | 45 |
|
29 | | -Permission is hereby granted, free of charge, to any person obtaining a copy |
30 | | -of this software and associated documentation files (the "Software"), to deal |
31 | | -in the Software without restriction, including without limitation the rights |
32 | | -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
33 | | -copies of the Software, and to permit persons to whom the Software is |
34 | | -furnished to do so, subject to the following conditions: |
35 | | - |
36 | | -The above copyright notice and this permission notice shall be included in all |
37 | | -copies or substantial portions of the Software. |
| 46 | +## Documentation |
38 | 47 |
|
39 | | -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
40 | | -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
41 | | -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
42 | | -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
43 | | -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
44 | | -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
45 | | -SOFTWARE. |
| 48 | +The documentation is available [here](http://fcm.readthedocs.org/en/latest/) |
0 commit comments