Format README titles appropriately
This commit is contained in:
David Cormier
parent
aef707a12f
commit
2599edec5a
29
README.md
29
README.md
|
|
@ -1,10 +1,9 @@
|
|||
A web client for WeeChat [](https://travis-ci.org/glowing-bear/glowing-bear?branch=master)
|
||||
========================
|
||||
#A web client for WeeChat [](https://travis-ci.org/glowing-bear/glowing-bear?branch=master)
|
||||
|
||||
Glowing Bear is a web frontend for the [WeeChat](http://weechat.org) IRC client and strives to be a modern interface. It relies on WeeChat to do all the heavy lifting and then provides some nice features on top of that, like embedding images, videos, and other content. The best part, however, is that you can use it from any modern internet device -- whether it's a computer, tablet, or smart phone -- and all your stuff is there, whereever you are. You don't have to deal with the messy technical details, and all you need to have installed is a browser or our app.
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
##Getting Started
|
||||
|
||||
|
||||
Glowing Bear connects to the WeeChat instance you're already running (version 0.4.2 or later is required), and you need to be able to establish a connection to the WeeChat host from your device. It makes use of the relay plugin, and therefore you need to set up a relay. If you want to get started as quickly as possible, use these commands in WeeChat:
|
||||
|
||||
|
|
@ -19,30 +18,26 @@ You can run Glowing Bear in many ways: use it like any other webpage, as an app
|
|||
|
||||
<a href="https://play.google.com/store/apps/details?id=com.glowing_bear"><img alt="Android app on Google Play" src="https://developer.android.com/images/brand/en_app_rgb_wo_45.png" /></a><a href="https://marketplace.firefox.com/app/glowing-bear/"><img alt="Firefox OS app in the Firefox Marketplace" src="https://marketplace.cdn.mozilla.net/media/img/mkt/badges/firefox-marketplace_badge-orange_129_45.png" /></a>
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
##Screenshots
|
||||
|
||||
Running as Chrome application in a separate window on Windows and as Android app:
|
||||
|
||||
|
||||
|
||||
How it Works
|
||||
------------
|
||||
##How it Works
|
||||
|
||||
What follows is a more technical explanation of how Glowing Bear works, and you don't need to understand it to use it.
|
||||
|
||||
Glowing Bear uses WeeChat directly as its backend through the relay plugin. This means that we can connect to WeeChat directly from the browser using WebSockets. Therefore, 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.
|
||||
|
||||
FAQ
|
||||
---
|
||||
##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. This is handled by your browser, and we have no influence on certificate handling, etc. You can find more detailed instructions on how to communicate securely in the "encryption instructions" tab on the [landing page](http://www.glowing-bear.org). A detailed guide on setting up a trusted secure relay is available [here](https://4z2.de/2014/07/06/weechat-trusted-relay).
|
||||
|
||||
Development
|
||||
-----------
|
||||
##Development
|
||||
|
||||
Setup
|
||||
^^^^^
|
||||
###Setup
|
||||
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.
|
||||
|
||||
Here's a simple example using the python simple web server:
|
||||
|
|
@ -60,8 +55,7 @@ If you'd prefer a version hosted with HTTPS, GitHub serves that as well with an
|
|||
|
||||
You can also use the latest and greatest development version of Glowing Bear at [https://latest.glowing-bear.org/](https://latest.glowing-bear.org/).
|
||||
|
||||
Running the tests
|
||||
^^^^^^^^^^^^^^^^^
|
||||
###Running the tests
|
||||
Glowing Bear uses Karma and Jasmine to run its unit tests. To run the tests locally, you will first need to install `npm` on your machine. Check out the wonderful [nvm](https://github.com/creationix/nvm) if you don't know it already, it's highly recommended.
|
||||
|
||||
Once this is done, you will need to retrieve the necessary packages for testing Glowing-Bear (first, you might want to use `npm link` on any packages you have already installed globally):
|
||||
|
|
@ -76,8 +70,7 @@ Or the end to end tests:
|
|||
`$ npm run protractor`
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
##Contributing
|
||||
|
||||
Whether you are interested in contributing or simply want to talk about the project, join us at **#glowing-bear** on **freenode**!
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue