diff --git a/README.md b/README.md index 2eb8a0a..391f431 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# Fancy-Animal-Short-Urls +# Plugin for YOURLS: Fancy Animals Short URLs + YOURLS Plugin to create cool short URLS like https://short.rip/SwiftCrimsonBullfrog + +Check out more [![Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/) Plugins! + + +Original plugin by Ozh: [Word Based Short Urls](https://github.com/ozh/yourls-word-based-short-urls) + +## What for + +Generate memorable "short" URLs with adjectives and nouns, such as `http://yoursite/BronzeWordyTurtle` (well, they will be less shorter, but more memorable :) + + +## How to + +* In `/user/plugins`, create a new folder named `fancy-animals-short-urls` or simply `git clone https://github.com/cfultz/Fancy-Animal-Short-Urls` there +* Drop these files in that directory (skip if you git clone instead) +* Go to the Plugins administration page and activate the plugin +* Have fun + + +## FAQ + +1. "it doesn't work!" + * Sorry, it does for me. + +2. "Can I customize the words ?" + * Sure. Replace the three text files with your own, one word per line. + + +## License + +Do whatever the hell you want with it.