From 5be5ab658bad18c3a255337bebd9b018aa6ff42c Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Tue, 25 Aug 2015 16:59:36 +0100 Subject: [PATCH] Updated readme with wiki links --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5b7edd4..417be76 100644 --- a/README.md +++ b/README.md @@ -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. +