From c4acc192d9e6b023334156706b9974006652d6d6 Mon Sep 17 00:00:00 2001 From: Till Höppner Date: Sun, 24 Jan 2016 00:10:44 +0100 Subject: Another readme change --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9632c86..b79b766 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,15 @@ ilc [![Crates.io version](https://img.shields.io/crates/v/ilc.svg?style=flat-square)](https://crates.io/crates/ilc) [![Crates.io license](https://img.shields.io/crates/l/ilc.svg?style=flat-square)](https://crates.io/crates/ilc) -**So... what is this thing?** +**What is this thing?** ilc is a library to work with common IRC log formats, as well as a collection of commonly needed utilities for IRC logs. -The library can convert between most of the EnergyMech and Weechat3 log formats, as well as binary and msgpack representations of them. -The tools can pretty-print them, and count the lines/words that people said in them. +The library can convert between most of the EnergyMech (ZNC) and Weechat3 log formats, as well as binary and msgpack representations of them. +The tools can merge, convert, and pretty-print them, or count the lines/words that people said in them. -**Are you stupid? Why Rust?** - -Uhh, actually... that may have been a suboptimal choice. Nobody cares about performance here -anyways. But it was what I started with, and I didn't feel like rewriting it. - -**Fine, I'll use it. Do I really have to compile it?** +**Fine, I'll try it. Do I really have to compile it myself?** Probably. I sporadically [release a binary](https://github.com/tilpner/ilc/releases), but those are for x86-64 Linux. If you want something else, or more recent, you'll have to compile yourself. @@ -57,3 +52,17 @@ Options: --out -o OUT Give an output file, instead of stdout. --infer-date Try to use the filename as date for the log. ``` + +**Are you stupid? Why Rust?** + +Uhh, actually... that may have been a suboptimal choice. Nobody cares about performance here +anyways. But it was what I started with, and I didn't feel like rewriting it. + +**I found a bug!** + +Great! Or... well, not so great. Please file it [here](https://github.com/tilpner/ilc/issues/new)! + +**It doesn't support my format.** + +Support for irssi is planned, but beyond that you'll have to file an issue or implement it yourself. +PRs are welcome, but I can't promise to merge all of them without revision. :) -- cgit v1.2.3