README.md (1291B)
1 # WeechatRN 2 3 An attempt to bring iOS users in on the good life of [weechat-android](https://github.com/ubergeek42/weechat-android). 4 5 ## Supported connection options 6 7 The only supported option for connecting to a weechat instance is through websockets. 8 9 ## Development 10 11 ```bash 12 # Install expo-cli 13 yarn global add expo-cli 14 15 # Install dependencies for project 16 yarn install 17 18 # Launch Expo 19 yarn start 20 ``` 21 22 On your device, scan the QR code with the Camera app (iOS) or the [Expo Client](https://play.google.com/store/apps/details?id=host.exp.exponent&referrer=www) (Android). 23 24 ## Example configuration 25 26 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. 27 28 ### Weechat configuration: 29 30 ``` 31 /relay add ssl.weechat 5555 32 /set relay.network.password <your secret password> 33 ``` 34 35 Note that weechatRN requires the relay to be configured with the "weechat" protocol, not the "irc" protocol. 36 37 ### Webserver configuration (probably not needed): 38 39 If you need to proxy though another host and happen to be using Caddy as your webserver, you can use my config file below: 40 41 Caddy: 42 43 ``` 44 example.com { 45 log stdout 46 errors stderr 47 proxy /weechat localhost:5555 { 48 websocket 49 } 50 } 51 ``` 52 53 ## License 54 55 [MIT License](LICENSE)