archive/hipchat-emoticons-for-all
Archived
1
Fork 0
Code Releases Packages Activity

Updated readme with wiki links

Browse source
This commit is contained in:
Jake Howard 2015-08-25 16:59:36 +01:00
parent 5d5a5ed02a
commit 5be5ab658b
1 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,21 +1,20 @@
# Hipchat Emoticons for all! #
## Building for yourself ##
Whilst I recommend that you use the plugins that are on the add-on stores of the respective browsers, building the apps yourself is perfectly possible, and __should__ be self contained within this application. I am building this on Ubuntu 15.04, but your luck may vary on other platforms.
### Build Commands ###
npm install
npm run build
npm run build-chrome
npm run build-firefox
npm run build-extensions (firefox and chrome)
Cross-platform browser extension allowing use of hipchat emoticons on a variety of different websites. Using both client-side decoding, and markdown embedding.
### Modification ###
If you want to modify the code in any way, you must run `npm run develop`. This build all the code, but doesnt delete any files you may have modified as `npm run build` does.
## Download and Installation ##
Download for Firefox: [Visit AMO]() __(Coming Soon)__
Download for Chrome: [Visit Chrome app store]() __(Coming Soon)__
## 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 possibly run smoother too.
Alternatively, you can [Build it yourself](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki/Building-for-yourself)!
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.
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!
## More Info ##
More information can be found in the [Wiki](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki)
More information can be found in the [Wiki](https://github.com/RealOrangeOne/hipchat-emoticons-for-all/wiki).
## 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.