tobast/glowingbear-mainbox
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fix a few things in the README

Browse source 
@torhve, please cherry-pick onto your PR :)
This commit is contained in:
Lorenz Hübschle-Schneider 2014-04-25 20:06:05 +01:00 committed by Tor Hveem
parent bcc51ef254
commit f7e1e97b2b
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -3,13 +3,13 @@ A web client for WeeChat [![Build Status](https://api.travis-ci.org/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 notification. 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 notification.
Glowing Bear uses WeeChat as directly as the backend. This HTML5 frontend uses WeeChat's relay plugin that allows us to directly connect from the browser to WeeChat using Websockets. This means that the client does not need a special "backend service", as all that is provided by the IRC client itself and this front end consists only of HTML/CSS/JavaScript. 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 Gloing Bear in multiple ways, just like any old webpage, Firefox app, Chrome app, Chrome app on android (Add to homescreen), and also we provide an Android .APK package available in the Android market. 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.
Get started Getting started
== ===============
Required WeeChat version: 0.4.2 Required WeeChat version: 0.4.2
@ -18,7 +18,7 @@ To use the web interface you first need to set a relay and a password:
/relay add weechat 9001 /relay add weechat 9001
/set relay.network.password YOURPASSWORD /set relay.network.password YOURPASSWORD
Then go to the GitHub hosted version of [Glowing Bear](http://glowing-bear.github.io/glowing-bear) ! Then go to the GitHub hosted version of [Glowing Bear](https://glowing-bear.github.io/glowing-bear)!
Screenshots Screenshots
@ -34,15 +34,16 @@ Running as Firefox application on Android:
Hosting Glowing Bear yourself Hosting Glowing Bear yourself
= =============================
If you want to host the HTML application yourself it is enough to clone it and serve the pages with a webserver. As an example, this is how to host it using the python simple web server: 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 git clone https://github.com/glowing-bear/glowing-bear
cd glowing-bear cd glowing-bear
python -m SimpleHTTPServer python -m SimpleHTTPServer
Now you can point your browser to [http://localhost:8000](http://localhost:8000)!
---- ----
Interested in contributing or simply want to talk about the project? Join us on **#glowing-bear** on **freenode**! Interested in contributing or simply want to talk about the project? Join us at **#glowing-bear** on **freenode**!