Skip to content

Commit 32f14c2

Browse files
author
Stefan Aichholzer
committed
Consistent readme. Version bump.
1 parent 6fd06cd commit 32f14c2

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
1-
[![Dependency status](https://gemnasium.com/badges/github.com/WhirIO/Client.svg)](https://gemnasium.com/github.com/WhirIO/Client)
2-
[![Alpha](https://img.shields.io/badge/status-alpha-8456AC.svg)](https://github.com/WhirIO/Client)
1+
<p align="center">
2+
👏🏻 😎 🚀 😻
3+
</p>
34

45
<p align="center">
56
<a href="http://whir.io"><img src="https://raw.githubusercontent.com/WhirIO/Client/master/media/whir.png" alt="whir.io" width="420" /></a>
67
</p>
8+
<p>&nbsp;</p>
79

10+
[![Alpha](https://img.shields.io/badge/Status-ALPHA-8456AC.svg)](https://github.com/WhirIO/Client)
11+
[![ES7](https://img.shields.io/badge/Uses-ES7-00008B.svg)](https://github.com/WhirIO/Client)
12+
[![Downloads](https://img.shields.io/npm/dt/whir.io.svg)](https://www.npmjs.com/package/whir.io)
13+
[![Dependency status](https://gemnasium.com/badges/github.com/WhirIO/Client.svg)](https://gemnasium.com/github.com/WhirIO/Client)
14+
15+
As a developer, I use my command line a lot so why not integrate chat directly into it?<br />
16+
**whir** aims to close this gap by providing a simple, flexible, extend-able and blazing fast chat environment, without having to install additional applications.
817

918
### Installation
19+
**whir** is written in JavaScript and you should have installed the latest version of Nodejs.
1020
```
1121
$> npm i -g whir.io
1222
```
1323

1424

1525
### Options:
16-
- `--user || -u`: Your username (per channel) `Required`
17-
- `--pass || -p`: Password, for private channels.
18-
- `--channel || -c`: Channel you are joining (or creating) `Default: random name`
19-
- `--host || -h`: Whir's host `Default: chat.whir.io`
20-
- `--mute || -m`: Mute the conversation.
26+
- `--user` || `-u`: Your username (per channel) `Required`
27+
- `--channel` || `-c`: Channel you are joining (or creating) `Default: [random]`
28+
- `--host` || `-h`: Whir's host `Default: chat.whir.io`
29+
- `--pass` || `-p`: Password, for private channels
30+
- `--mute` || `-m`: Mute this conversation
2131

2232

2333
### Chat:
@@ -34,16 +44,15 @@ $> whir.io -u stefan -c friends
3444
or
3545

3646
```
47+
// Random channel and muted conversation.
3748
$> whir.io -u stefan -m
38-
// Connected to a random channel.
39-
// The conversation is muted.
4049
```
4150

4251
or
4352

4453
```
45-
$> whir.io -u stefan -c friends -h myawesomedomain.chat
4654
// Running whir on your own server/domain.
55+
$> whir.io -u stefan -c friends -h myawesomedomain.chat
4756
```
4857

4958

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "whir.io",
3-
"version": "1.3.3",
3+
"version": "1.3.4",
44
"description": "The whir.io chat client. [alpha]",
55
"author": {
66
"name": "Stefan Aichholzer",

0 commit comments

Comments
 (0)