Update README.md
This commit is contained in:
parent
6a67e310dd
commit
b16f65b72b
32
README.md
32
README.md
@ -4,35 +4,23 @@ Run your IRC client on a server and access it from the web browser. This allows
|
|||||||
|
|
||||||
### [Try the Shout client](http://shout-irc.com:9090/)
|
### [Try the Shout client](http://shout-irc.com:9090/)
|
||||||
|
|
||||||
_Some highlights:_
|
|
||||||
|
|
||||||
- [x] Multiple user support
|
|
||||||
- [x] Supports anonymous (public) or passworded connections
|
|
||||||
- [x] Works on your smartphone
|
|
||||||
|
|
||||||
## Screenshot
|
|
||||||
|
|
||||||
![](https://raw.github.com/erming/shout/master/screenshots/shout.png)
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
1. Install Node.js and npm
|
```
|
||||||
`sudo apt-get install nodejs-legacy npm`
|
sudo npm install -g shout
|
||||||
|
```
|
||||||
|
|
||||||
2. Clone the project from GitHub
|
## Usage
|
||||||
`git clone http://github.com/erming/shout`
|
|
||||||
|
|
||||||
3. Open folder
|
When the install is complete, go ahead and start the server:
|
||||||
`cd shout/`
|
|
||||||
|
|
||||||
4. Install packages
|
```
|
||||||
`sudo npm install --production`
|
shout start --port 9000
|
||||||
|
```
|
||||||
|
|
||||||
5. Run the server
|
## Screenshots
|
||||||
`npm start` or `node index.js`
|
|
||||||
|
|
||||||
6. Open your browser
|
![](https://raw.github.com/erming/shout/master/screenshots/shout.png)
|
||||||
`http://localhost:9000`
|
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user