1
Fork 0
This repository has been archived on 2023-03-26. You can view files and clone it, but cannot push or open issues or pull requests.
hipchat-emoticons-for-all/README.md

28 lines
1.6 KiB
Markdown
Raw Normal View History

2015-08-19 18:18:22 +01:00
# Hipchat Emoticons for all! #
2015-08-19 15:45:09 +01:00
2015-08-25 16:59:36 +01:00
Cross-platform browser extension allowing use of hipchat emoticons on a variety of different websites. Using both client-side decoding, and markdown embedding.
2015-08-25 14:31:33 +01:00
2015-08-25 16:59:36 +01:00
## Download and Installation ##
2015-08-25 17:01:58 +01:00
* Download for Firefox: [Visit AMO]() __(Coming Soon)__
* Download for Chrome: [Visit Chrome app store]() __(Coming Soon)__
2015-08-25 16:59:36 +01:00
2015-08-25 17:01:24 +01:00
Alternatively, you can [Build it yourself](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki/Building-for-yourself) using these instructions!
2015-08-24 21:25:18 +01:00
2015-08-25 16:59:36 +01:00
Once installed into your browser, [Click here](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki/Test-the-plugin-works-correctly) to make sure it's working perfectly!
2015-08-25 14:59:59 +01:00
2015-08-25 17:01:24 +01:00
2015-08-25 14:59:59 +01:00
## More Info ##
2015-08-25 16:59:36 +01:00
More information can be found in the [Wiki](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki).
2015-08-25 17:46:36 +01:00
## Adding Features ##
If there is something you think could be done better, differently, or something new alltogether, read [This](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki/Adding-Features) to find out the best way to do it and how it's done. Any feature suggestion is appreciated!
2015-08-25 16:59:36 +01:00
## Disclaimer ##
As you can tell, the quality of the code isnt perfect, or to a particular standard. Once the plugin works properly to a basic level, I will install some linting software to make the code look nicer, and hopefully run smoother too.
All the time the app has a version of `0.0.0`, the extensions are considered to be unstable and unlikely to work properly, if at all.
2015-09-22 15:34:42 +01:00
## Example ##
The sytax used is identical to what is used in the hipchat applications: wrapping the identifier in brackets `()`. For example, (yey) (allthethings) (boom) .