Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
kodi committed Aug 25, 2019
1 parent 98a3c68 commit 2c99d9c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

## Instalation

To install globally, do:
```
npm i -g splex
```

## What is Splex
Need to watch 4 log files?

Tired of doing `tail -f log.file` in 4 terminal panels/tabs/windows?
Expand All @@ -19,7 +26,7 @@ Enter **Splex**

Splex is a streaming log multiplexer for node.

Pass in multiple files as aguments, to watch streaming in real time
Pass in multiple files as aguments, and watch them stream all at once in a single window, nicely color coded by log file, or even separated in table-like format for easier reading.

Example commands

Expand All @@ -34,10 +41,3 @@ splex -t -c yellow,blue logs/log-0.log logs/log-1.log logs/log-2.log logs/log-3.

![custom colors](img/custom_colors.png)


## Instalation

To install globally, do:
```
npm i -g splex
```

0 comments on commit 2c99d9c

Please sign in to comment.