Files
SOP.wtf/user/plugins/telepathics-yourls-emojis/README.md
2022-10-30 14:32:20 -07:00

35 lines
1.8 KiB
Markdown

# YOURLS Emojis
A YOURLS plugin that allows emojis in the custom short URLs.
## Description
Emojis in domain names and URLs are becoming increasingly popular, so I thought it would be fun to be able to include them in your YOURLS short codes.
[![Mentioned in Awesome YOURLS](https://awesome.re/mentioned-badge.svg)](https://github.com/YOURLS/awesome-yourls/)
[![Github Sponsors](https://img.shields.io/badge/sponsors-4-green.svg)](https://github.com/sponsors/telepathics)
[![PHP Composer](https://github.com/telepathics/yourls-emojis/actions/workflows/php.yml/badge.svg?branch=main)](https://github.com/telepathics/yourls-emojis/actions/workflows/php.yml)
## Installation
1. Unzip the [latest release](https://github.com/telepathics/yourls-emojis/releases) and move it into your YOURLS `/user/plugins` folder
2. Visit your plugins page (e.g. https://sho.rt/admin/plugins.php)
3. Activate the "Emojis" plugin by telepathics
4. Have fun!
### Upgrading
1. Delete (or replace) the old folder
2. Follow aforementioned installation instructions
## Contributing
Feature suggestion? Bug to report?
__Before opening any issue, please search for existing [issues](https://github.com/telepathics/yourls-emojis/issues) (open and closed) and read the [Contributing Guidelines](https://github.com/telepathics/yourls-emojis/blob/main/.github/CONTRIBUTING.md).__
Also visit the living [to do](https://github.com/telepathics/yourls-emojis/projects/1) kanban board and [discussions](https://github.com/telepathics/yourls-emojis/discussions) page.
## License
Released under the [MIT License](https://opensource.org/licenses/MIT).
See also:
[YOURLS](https://github.com/YOURLS/YOURLS) ♡
[SteppingHat/php-emoji-detector](https://github.com/SteppingHat/php-emoji-detector) ♡ [unicode.org](https://unicode.org/Public/emoji/13.1/emoji-test.txt)