diff --git a/README.md b/README.md new file mode 100644 index 0000000..11fc79c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# ulauncher-symbol + +A [Ulauncher](https://ulauncher.io/) extension for searching Unicode and ASCII characters and copying them to the clipboard. Dark mode friendly. + +Enter to copy the symbol itself. + +Alt+Enter to copy the HTML entity (if it exists). + +You can search for characters using their name or description, block names or the characters themselves. + +## Demonstration + +(Image needs to be updated for this fork.) + +![Demonstration of ulauncher-symbol](ulauncher-unicode-demo.gif) + +## Installation + +Open Ulauncher, go to `Preferences > Extensions > Add extension` and paste the project's URL: `https://github.com/rootwork/ulauncher-symbol.git` + +## Source + +Forked from [zensoup/ulauncher-unicode](https://github.com/zensoup/ulauncher-unicode) to add HTML entities, dark mode theming, fewer false positives in results, and an updated Unicode list. + +## License + +GPLv3. See [LICENCE](LICENCE). \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 853b79b..0000000 --- a/README.rst +++ /dev/null @@ -1,36 +0,0 @@ -ulauncher-unicode ------------------ - -A `Ulauncher`_ extension for searching unicode characters and copying them to the clipboard. - - -Demo -==== - -.. image:: ulauncher-unicode-demo.gif - - -Installation -============ - -Open ulauncher, go to ``preferences > extensions > Add extension`` and paste the project's URL: ``https://github.com/zensoup/ulauncher-unicode`` - - -Usage -===== - -You can search for characters using their name or description, block names or the characters themselves. - -The character list is automatically generated from https://www.unicode.org - - -Checklist -========= - - - -☐ Add support for character combinations like skin tones, flags and combined emojis using alt+enter. - - - -.. _Ulauncher: https://ulauncher.io/