index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="description" content="Resilient command line chat platform.">
    <meta name="author" content="https://github.com/aichholzer">
    <link rel="icon" type="image/png" href="./static/img/favicon.png">
    <title>whir.io</title>

    <link href="https://fonts.googleapis.com/css?family=Muli|Oleo+Script" rel="stylesheet">
    <link href="./static/css/bootstrap.min.css" rel="stylesheet">
    <link href="./static/css/ie10-viewport-bug-workaround.css" rel="stylesheet">
    <link href="./static/css/whir.io.css" rel="stylesheet">

    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
</head>
<body>
    <div class="container">
        <div class="row header">
            <div class="col-md-8 col-md-offset-2" style="text-align: center;">
                👏🏻
                <a href="https://github.com/WhirIO"><i class="fa fa-github-alt fa-1x" aria-hidden="true"></i></a>
                😎
                <a href="https://github.com/aichholzer"><i class="fa fa-heart fa-1x" aria-hidden="true"></i></a>
                🚀
                <a href="http://goo.gl/kBXsBE"><i class="fa fa-globe fa-1x" aria-hidden="true"></i></a>
                😻
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <p style="text-align: center;">
                    <img src="./static/img/whir.png" alt="whir.io" class="logo" />
                </p>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <p>
                    <a href="https://github.com/WhirIO/Client">
                        <img src="https://img.shields.io/badge/Status-ALPHA-8456AC.svg" alt="Alpha" data-canonical-src="https://img.shields.io/badge/Status-ALPHA-8456AC.svg" style="max-width:100%;">
                    </a>
                    <a href="https://www.ecma-international.org/ecma-262/7.0/">
                        <img src="https://img.shields.io/badge/JavaScript-ES7-00008B.svg" alt="Javascript ES7" data-canonical-src="https://img.shields.io/badge/JavaScript-ES7-00008B.svg" style="max-width:100%;">
                    </a>
                    <a href="https://codebeat.co/projects/github-com-whirio-client-master">
                        <img src="https://codebeat.co/badges/f82e9789-770f-4a7a-a8e5-c9e061f71f77" alt="Downloads" data-canonical-src="https://codebeat.co/badges/f82e9789-770f-4a7a-a8e5-c9e061f71f77" style="max-width:100%;">
                    </a>
                    <a href="https://www.codacy.com/app/aichholzer/Client?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=WhirIO/Client&amp;utm_campaign=Badge_Grade">
                        <img src="https://api.codacy.com/project/badge/Grade/a360fc01aeab4d7084254dc6c09de3d9" alt="Downloads" data-canonical-src="https://api.codacy.com/project/badge/Grade/a360fc01aeab4d7084254dc6c09de3d9" style="max-width:100%;">
                    </a>
                    <a href="https://www.npmjs.com/package/whir.io">
                        <img src="https://img.shields.io/npm/dt/whir.io.svg" alt="Downloads" data-canonical-src="https://img.shields.io/npm/dt/whir.io.svg" style="max-width:100%;">
                    </a>
                    <a href="https://gemnasium.com/github.com/WhirIO/Client">
                        <img src="https://gemnasium.com/badges/github.com/WhirIO/Client.svg" alt="Dependency status" data-canonical-src="https://gemnasium.com/badges/github.com/WhirIO/Client.svg" style="max-width:100%;">
                    </a>
                </p>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <p>
                    As a developer, I use my command line a lot so why not integrate chat directly into it?<br />
                    <strong>whir</strong> aims to close this gap by providing a simple, flexible, extend-able and blazing fast chat environment, without having to install additional applications.
                </p>
                <p><strong>whir</strong> does not store messages in any form.</p>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <p><strong>whir</strong> is written in JavaScript and you should have installed the latest version of Nodejs.</p>
                <pre>$> npm install -g whir.io</pre>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <h4>Options:</h4>
                <ul>
                    <li><code>--user</code> || <code>-u</code> Your username (per channel) <code class="tag">Required</code></li>
                    <li><code>--channel</code> || <code>-c</code> Channel you are joining (or creating) <code class="tag">Default: [random]</code></li>
                    <li><code>--host</code> || <code>-h</code> Whir's host <code class="tag">Default: chat.whir.io</code></li>
                    <li><code>--pass</code> || <code>-p</code> Password, for private channels</li>
                    <li><code>--mute</code> || <code>-m</code> Mute this conversation</li>
                </ul>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <h4>Chat:</h4>
                <pre>$> whir.io --user=stefan --channel=friends</pre>
                <p>or</p>
                <pre>$> whir.io -u stefan -c friends</pre>
                <p>or</p>
                <pre>// Random channel and muted conversation.
$> whir.io -u stefan -m</pre>
                <p>or</p>
                <pre>// Running whir on your own server/domain.
$> whir.io -u stefan -c friends -h myawesomedomain.chat</pre>
            </div>
        </div>
        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <h4>Help:</h4>
                <p>
                    Once connected, type <code>/help</code> for a list of basic commands.<br />
                    Type <code>/exit</code> to leave at any time.
                </p>
            </div>
        </div>

        <div class="row">
            <div class="col-md-8 col-md-offset-2">
                <h4>Notes:</h4>
                <p>You can also setup and run your own <strong>whir</strong> server.<br>
                    Here's how to do that: <a href="https://github.com/WhirIO/Server">https://github.com/WhirIO/Server</a></p>
            </div>
        </div>
    </div>
    <script src="./static/js/ie10-viewport-bug-workaround.js"></script>
    <script src="https://use.fontawesome.com/55b0a87b1f.js"></script>
    <script>
        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function() {
            (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
        ga('create', 'UA-83578103-1', 'auto');
        ga('send', 'pageview');
    </script>
</body>
</html>