Skip to content

Commit b463920

Browse files
author
Amr Alshroof
committed
update README
1 parent da50155 commit b463920

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

README.md

+32-23
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,44 @@
1-
<snippet>
2-
<content><![CDATA[
3-
# ${1:Project Name}
4-
TODO: Write a project description
5-
## Installation
1+
# Firebase Notifications Yii2
62

7-
The preferred way to install this extension is through composer.
3+
This extension will make send firebase notifications easy to do for the Yii2 framework.
4+
5+
## Getting Started
6+
7+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
8+
9+
### Prerequisities
10+
11+
Yii2 application
12+
```
13+
composer require yiisoft/yii2
14+
```
15+
16+
### Installing
17+
18+
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
819

920
Either run
1021

22+
```
1123
php composer.phar require --prefer-dist "opensooq/yii2-firebase-notifications": "dev-master"
1224
25+
```
26+
1327
or add
1428

29+
```
1530
"opensooq/yii2-firebase-notifications": "dev-master"
16-
31+
```
1732
to the require section of your composer.json file.
1833

1934
## Usage
20-
TODO: Write usage instructions
21-
## Contributing
22-
1. Fork it!
23-
2. Create your feature branch: `git checkout -b my-new-feature`
24-
3. Commit your changes: `git commit -am 'Add some feature'`
25-
4. Push to the branch: `git push origin my-new-feature`
26-
5. Submit a pull request :D
27-
## History
28-
TODO: Write history
29-
## Credits
30-
TODO: Write credits
31-
## License
32-
TODO: Write license
33-
]]></content>
34-
<tabTrigger>readme</tabTrigger>
35-
</snippet>
35+
36+
```ruby
37+
$service = new FirebaseNotifications('YOUR_KEY');
38+
39+
$service->send($tokens,$message);
40+
```
41+
you can clone the android build [here](https://github.com/Amr-alshroof/Fcm-Android),
42+
and use it to test your code.
43+
44+

0 commit comments

Comments
 (0)