weechatRN

Weechat relay client for iOS using websockets https://github.com/mhoran/weechatRN
git clone http://git.hanabi.in/repos/weechatRN.git
Log | Files | Refs | README | LICENSE

commit 081ebc219cdb642147129d5a262f336504f368e5
parent c0e1797e5bf046a4d61d7841a209683e5870e40f
Author: Johan Lindskogen <johan.lindskogen@gmail.com>
Date:   Mon,  2 Apr 2018 23:00:16 +0200

Add readme

Diffstat:
AREADME.md | 51+++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 51 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md @@ -0,0 +1,51 @@ +# WeechatRN + +An attempt to bring iOS users in on the good life of [weechat-android](https://github.com/ubergeek42/weechat-android). + +## Supported connection options + +The only supported option for connecting to a weechat instance is through websockets. + +## Development + +```bash +# Install react-native-cli +yarn add global react-native-cli + +# Install dependencies for project +yarn install + + +# Launch iOS simulator +react-native run-ios + +# Run on Android device (not tested) +react-native run-android +``` + +## Example configuration + +All examples below uses `example.com` as hostname, and `5555` as port number, but you should of course replace them with your own values as needed. + +### Weechat configuration: + +``` +/relay add ssl.weechat 5555 +/set relay.network.password <your secret password> +``` + +### Webserver configuration (probably not needed): + +If you need to proxy though another host and happen to be using Caddy as your webserver, you can use my config file below: + +Caddy: + +``` +example.com { + log stdout + errors stderr + proxy /weechat localhost:5555 { + websocket + } +} +```