Skip to content
This repository was archived by the owner on Jun 6, 2021. It is now read-only.

Commit 4df1065

Browse files
authored
Update README.md
1 parent 8fbf937 commit 4df1065

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
> The next generation of the KiwiIRC web based IRC client
44
5-
## Development dependencies
5+
### Development dependencies
66
Before you can build or start to develop on KiwiIRC, make sure the have the
77
following installed on your system:
88
* [Nodejs](https://nodejs.org/)
99
* [yarn](https://yarnpkg.com/)
1010

11-
## Building
11+
### Building
1212

1313
``` bash
1414
# install dependencies
@@ -18,7 +18,7 @@ yarn install
1818
npm run build
1919
```
2020

21-
## Development environment
21+
### Development environment
2222

2323
``` bash
2424
# install dependencies
@@ -30,8 +30,16 @@ npm run dev
3030

3131
Source files are linted automatically and will fail on any linting errors.
3232

33-
## Configuration
33+
### Configuration
3434

3535
By default, the client will load the /static/config.json file on startup which
3636
contains any runtime configuration. When in the development environment this can
3737
be found in [static/config.json](static/config.json)
38+
39+
## Getting started
40+
41+
This repository only contains the client side. To connect to an IRC server you either need to be using a websocket capable IRC server (none yet support this) or need to be running to Kiwi IRC server which can be found here: https://github.com/kiwiirc/webircgateway
42+
43+
Once you have a Kiwi IRC server configured and running, enter the URL to your Kiwi IRC server in the clients config.json file. The client side files built from this repository may be hosted anywhere - Apacahe, Nginx, the Kiwi IRC server, your CDN.
44+
45+
***TODO: Provide a full example of the client and server running together with complete downloadable packages***

0 commit comments

Comments
 (0)