Skip to content

Commit 68427a2

Browse files
docs(readme): 💙 💖 Update readme
1 parent 283f125 commit 68427a2

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Quality Score](https://img.shields.io/scrutinizer/g/unicodeveloper/laravel-emoji.svg?style=flat-square)](https://scrutinizer-ci.com/g/unicodeveloper/laravel-emoji)
77
[![Total Downloads](https://img.shields.io/packagist/dt/unicodeveloper/laravel-emoji.svg?style=flat-square)](https://packagist.org/packages/unicodeveloper/laravel-emoji)
88

9-
> A Laravel 5 Package for Using & Working With Emojis
9+
> A Laravel 5 Package for Using & Working With Emojis in your Laravel Apps
1010
1111
## Installation
1212

@@ -36,11 +36,29 @@ Also, register the Facade like so:
3636

3737
## Usage
3838

39+
Translate Emoji names to Unicode and Vice-versa.
40+
41+
```php
42+
>> Emoji::findByAlias("kissing_heart")
43+
=> "😘"
44+
45+
>> Emoji::findByName("sunglasses")
46+
=> "😎"
47+
48+
>> Emoji::findByUnicode("\u{1F603}")
49+
=> "smiley"
50+
51+
```
52+
This package contains some of the characters listed on http://unicode.org/emoji/charts/full-emoji-list.html
3953

4054
## Contributing
4155

4256
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
4357

58+
I am accepting PR's that add characters to emoji.php.
59+
Please use [this list](http://unicode.org/emoji/charts/full-emoji-list.html) to look up the unicode value and
60+
the name of the character.
61+
4462
## How can I thank you?
4563

4664
Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
@@ -50,6 +68,10 @@ Don't forget to [follow me on twitter](https://twitter.com/unicodeveloper)!
5068
Thanks!
5169
Prosper Otemuyiwa.
5270

71+
## Inspiration
72+
73+
* [Emoji](https://github.com/spatie/emoji)
74+
5375
## License
5476

5577
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)