From c7b2b4742fdc16af3f4433a2ac674f97cfd35a72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Wed, 21 May 2014 17:04:38 +0100 Subject: [PATCH 1/7] First try at improving the README, more to come --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d814645..1aeaa33 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,9 @@ A web client for WeeChat [![Build Status](https://api.travis-ci.org/glowing-bear/glowing-bear.png)](https://travis-ci.org/glowing-bear/glowing-bear) ======================== -Glowing Bear is a HTML5 web frontend for WeeChat that strives to be a modern and slick interface on top of WeeChat. It relies on WeeChat to do all the heavy lifting (connection, servers, history, etc) and then provides a few features on top of that, like content embedding (images, video) and desktop notifications. - -Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows us to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", everything is provided by the IRC client itself and this frontend is written in pure HTML/CSS/JavaScript. - -You can run Glowing Bear in multiple ways: use it like any other webpage, as a Firefox or Chrome app, a full-screen Chrome app on Android ("Add to homescreen"), and we also provide an Android app that you can install from the Google Play Store. +Glowing Bear is a HTML5 web frontend for WeeChat that strives to be a modern and slick interface on top of WeeChat. It relies on WeeChat to do all the heavy lifting (connection, servers, history, etc) and then provides some nice features on top of that, like content embedding (images, video) and desktop notifications. The main advantage, though, is that you can access it from any modern device without having to worry about ssh connections or terminal emulators. +Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows it to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", and you don't have to install anything. A connection is made from your browser to your WeeChat, with no services in between. Thus, Glowing Bear is written in pure client-side JavaScript with a bit of HTML and CSS. Getting started =============== @@ -20,6 +17,7 @@ To use the web interface you first need to set a relay and a password: Then go to the GitHub hosted version of [Glowing Bear](http://glowing-bear.github.io/glowing-bear)! +You can run Glowing Bear in multiple ways: use it like any other webpage, as a Firefox or Chrome app, or a full-screen Chrome app on Android ("Add to homescreen"). We also provide an [Android app](https://play.google.com/store/apps/details?id=com.glowing_bear) that you can install from the Google Play Store. Screenshots ---------- @@ -32,20 +30,25 @@ Running as Firefox application on Android: ![Glowing bear android screenshot](http://hveem.no/ss/weechat-web-android720.png) +Development +=========== -Hosting Glowing Bear yourself -============================= +Getting started with the development of Glowing Bear is really simple, partly because we don't have a build process (pure client-side JS, remember). All you have to do is clone the repository, fire up a webserver to host the files, and start fiddling around. You can try out your changes by reloading the page. -If you want to host the HTML application yourself, it is enough to clone it and serve the pages with a webserver. Here's a simple example using the python simple web server: - - git clone https://github.com/glowing-bear/glowing-bear - cd glowing-bear - python -m SimpleHTTPServer +Here's a simple example using the python simple web server: +```bash +git clone https://github.com/glowing-bear/glowing-bear +cd glowing-bear +python -m SimpleHTTPServer +``` Now you can point your browser to [http://localhost:8000](http://localhost:8000)! Remember that **you don't need to host Glowing Bear yourself to use it**, you can just use the [GitHub hosted version](http://glowing-bear.github.io/glowing-bear), and we'll take care of updates for you. Your browser connects to WeeChat directly, so it does not matter where Glowing Bear is hosted. ----- +If you'd prefer a version hosted with HTTPS, GitHub serves that with a undocumented, not officially supported link that as well. Be careful though, it might break any minute. Don't blame us if it stops working, you've been warned. Anyway, here's the link: [secret GitHub HTTPS link](https://glowing-bear.github.io/glowing-bear/) (the trailing forward slash in the URL seems to make all the difference). + +Contributing +------------ Interested in contributing or simply want to talk about the project? Join us at **#glowing-bear** on **freenode**! From 5f6ef781da086ed54ecb911064c396d1eff53e1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Wed, 21 May 2014 17:13:33 +0100 Subject: [PATCH 2/7] Compact screenshot --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1aeaa33..82572e0 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,9 @@ You can run Glowing Bear in multiple ways: use it like any other webpage, as a F Screenshots ---------- -Running as Chrome application in a separate window on Windows: - -![Glowing bear screenshot](http://hveem.no/ss/weechat-web-client720.png) - -Running as Firefox application on Android: - -![Glowing bear android screenshot](http://hveem.no/ss/weechat-web-android720.png) +Running as Chrome application in a separate window on Windows and as Firefox application on Android: +![Glowing bear screenshot](https://4z2.de/glowingbear.png) Development =========== From 6fc6ef68ffd6ea61746b8da84edb90ff9226876e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Wed, 21 May 2014 17:25:24 +0100 Subject: [PATCH 3/7] Add a bit of FAQ --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 82572e0..b08552e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Glowing Bear is a HTML5 web frontend for WeeChat that strives to be a modern and Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows it to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", and you don't have to install anything. A connection is made from your browser to your WeeChat, with no services in between. Thus, Glowing Bear is written in pure client-side JavaScript with a bit of HTML and CSS. Getting started -=============== +--------------- Required WeeChat version: 0.4.2 @@ -20,13 +20,19 @@ Then go to the GitHub hosted version of [Glowing Bear](http://glowing-bear.githu You can run Glowing Bear in multiple ways: use it like any other webpage, as a Firefox or Chrome app, or a full-screen Chrome app on Android ("Add to homescreen"). We also provide an [Android app](https://play.google.com/store/apps/details?id=com.glowing_bear) that you can install from the Google Play Store. Screenshots ----------- +----------- Running as Chrome application in a separate window on Windows and as Firefox application on Android: ![Glowing bear screenshot](https://4z2.de/glowingbear.png) +FAQ +--- + +- *Can I use Glowing Bear to access a machine or port not exposed to the internet by passing the connection through my server?* No, that's not what Glowing Bear does. You can use a websocket proxy module for your webserver to forward `/weechat` to your WeeChat instance though. Here are some pointers you might find helpful for setting this up with [nginx](http://nginx.com/blog/websocket-nginx/) or [apache](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html). +- *How does the encryption work?* TLS is used for securing the connection if you enable encryption. You can find more detailed instructions on how to communicate securely in the "encryption instructions" tab on the [landing page](http://glowing-bear.github.io/glowing-bear). Note that your browser will perform the certificate validation, so it is strongly recommended to use a certificate that your browser trusts. + Development -=========== +----------- Getting started with the development of Glowing Bear is really simple, partly because we don't have a build process (pure client-side JS, remember). All you have to do is clone the repository, fire up a webserver to host the files, and start fiddling around. You can try out your changes by reloading the page. From cc670e2ddd0387734da21ad34e999be69896aef2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Wed, 21 May 2014 17:27:39 +0100 Subject: [PATCH 4/7] README: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b08552e..f55436a 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Now you can point your browser to [http://localhost:8000](http://localhost:8000) Remember that **you don't need to host Glowing Bear yourself to use it**, you can just use the [GitHub hosted version](http://glowing-bear.github.io/glowing-bear), and we'll take care of updates for you. Your browser connects to WeeChat directly, so it does not matter where Glowing Bear is hosted. -If you'd prefer a version hosted with HTTPS, GitHub serves that with a undocumented, not officially supported link that as well. Be careful though, it might break any minute. Don't blame us if it stops working, you've been warned. Anyway, here's the link: [secret GitHub HTTPS link](https://glowing-bear.github.io/glowing-bear/) (the trailing forward slash in the URL seems to make all the difference). +If you'd prefer a version hosted with HTTPS, GitHub serves that as well with an undocumented, not officially supported (by GitHub) link. Be careful though, it might break any minute. Don't blame us if it stops working, you've been warned. Anyway, here's the link: [secret GitHub HTTPS link](https://glowing-bear.github.io/glowing-bear/) (the trailing forward slash in the URL seems to make all the difference). Contributing ------------ From b114d98a7ed9a3c572356a5c43ce9c539f0f6ce0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Wed, 21 May 2014 17:49:50 +0100 Subject: [PATCH 5/7] Contribution notes --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f55436a..4d45371 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ A web client for WeeChat [![Build Status](https://api.travis-ci.org/glowing-bear/glowing-bear.png)](https://travis-ci.org/glowing-bear/glowing-bear) ======================== -Glowing Bear is a HTML5 web frontend for WeeChat that strives to be a modern and slick interface on top of WeeChat. It relies on WeeChat to do all the heavy lifting (connection, servers, history, etc) and then provides some nice features on top of that, like content embedding (images, video) and desktop notifications. The main advantage, though, is that you can access it from any modern device without having to worry about ssh connections or terminal emulators. +Glowing Bear is an HTML5 web frontend for [WeeChat](http://weechat.org) that strives to be a modern and slick interface. It relies on WeeChat to do all the heavy lifting (connections, servers, history, etc) and then provides some nice features on top of that, like content embedding (images, video) and desktop notifications. The main advantage, though, is that you can access it from any modern internet device without having to worry about ssh connections or terminal emulators. Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows it to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", and you don't have to install anything. A connection is made from your browser to your WeeChat, with no services in between. Thus, Glowing Bear is written in pure client-side JavaScript with a bit of HTML and CSS. @@ -53,3 +53,7 @@ Contributing ------------ Interested in contributing or simply want to talk about the project? Join us at **#glowing-bear** on **freenode**! + +If you're curious about the projects we're using, here's a list: [AngularJS](https://angularjs.org/), [Bootstrap](http://getbootstrap.com/), [bindonce](https://github.com/Pasvaz/bindonce), [Underscore](http://underscorejs.org/), [favico.js](http://lab.ejci.net/favico.js/), and [zlib.js](https://github.com/imaya/zlib.js). Technology-wise, [WebSockets](http://en.wikipedia.org/wiki/WebSocket) are the most important part, but we also use [local storage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#localStorage), the [Notification Web API](https://developer.mozilla.org/en/docs/Web/API/notification), and last (but not least) [Apache Cordova](https://cordova.apache.org/) for our slick app. + +We always appreciate pull requests, and if you don't know where to get started, why not browse our [issue tracker](https://github.com/glowing-bear/glowing-bear/issues)? We're also always happy to hear which devices and platforms Glowing Bear works on (or doesn't) — for example, none of our current developers own an Apple device, so if you're interested in helping us test, we'd be most grateful! From 53b921c53949fb9a0c0c8735b00c6868402a4c0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Thu, 12 Jun 2014 12:33:44 +0100 Subject: [PATCH 6/7] Adapt text to changed screenshot --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d45371..956d9d4 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ You can run Glowing Bear in multiple ways: use it like any other webpage, as a F Screenshots ----------- -Running as Chrome application in a separate window on Windows and as Firefox application on Android: +Running as Chrome application in a separate window on Windows and as Android app: ![Glowing bear screenshot](https://4z2.de/glowingbear.png) From 145b7af592887f792924d0bdf2ac18fa15a55211 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lorenz=20H=C3=BCbschle-Schneider?= Date: Sat, 14 Jun 2014 12:55:00 +0100 Subject: [PATCH 7/7] Fix some wording issues --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 956d9d4..ee05adb 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A web client for WeeChat [![Build Status](https://api.travis-ci.org/glowing-bear Glowing Bear is an HTML5 web frontend for [WeeChat](http://weechat.org) that strives to be a modern and slick interface. It relies on WeeChat to do all the heavy lifting (connections, servers, history, etc) and then provides some nice features on top of that, like content embedding (images, video) and desktop notifications. The main advantage, though, is that you can access it from any modern internet device without having to worry about ssh connections or terminal emulators. -Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows it to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", and you don't have to install anything. A connection is made from your browser to your WeeChat, with no services in between. Thus, Glowing Bear is written in pure client-side JavaScript with a bit of HTML and CSS. +Glowing Bear uses WeeChat directly as the backend through its relay plugin, which allows it to directly connect to WeeChat from the browser using Websockets. That means that the client does not need a special "backend service", and you don't have to install anything. A connection is made from your browser to your WeeChat, with no services in between. Thus, Glowing Bear is written purely in client-side JavaScript with a bit of HTML and CSS. Getting started --------------- @@ -47,7 +47,7 @@ Now you can point your browser to [http://localhost:8000](http://localhost:8000) Remember that **you don't need to host Glowing Bear yourself to use it**, you can just use the [GitHub hosted version](http://glowing-bear.github.io/glowing-bear), and we'll take care of updates for you. Your browser connects to WeeChat directly, so it does not matter where Glowing Bear is hosted. -If you'd prefer a version hosted with HTTPS, GitHub serves that as well with an undocumented, not officially supported (by GitHub) link. Be careful though, it might break any minute. Don't blame us if it stops working, you've been warned. Anyway, here's the link: [secret GitHub HTTPS link](https://glowing-bear.github.io/glowing-bear/) (the trailing forward slash in the URL seems to make all the difference). +If you'd prefer a version hosted with HTTPS, GitHub serves that as well with an undocumented, not officially supported (by GitHub) link. Be careful though, it might break any minute. Anyway, here's the link: [secret GitHub HTTPS link](https://glowing-bear.github.io/glowing-bear/) (the trailing forward slash in the URL seems to make all the difference). Contributing ------------