From 55a42a23106a9f372b461bfb9eb645cc47170a30 Mon Sep 17 00:00:00 2001
From: Stephen <webmaster@scd31.com>
Date: Sat, 26 Sep 2020 14:18:24 -0300
Subject: [PATCH] Flesh out readme, rename project
---
Cargo.lock | 18 +++++++++---------
Cargo.toml | 3 ++-
README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++---
src/main.rs | 2 +-
4 files changed, 61 insertions(+), 14 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 441a43a..2ab0be5 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -72,6 +72,15 @@ dependencies = [
"winapi",
]
+[[package]]
+name = "dotacat"
+version = "0.1.0"
+dependencies = [
+ "clap",
+ "colored",
+ "rand",
+]
+
[[package]]
name = "getrandom"
version = "0.1.15"
@@ -129,15 +138,6 @@ version = "0.2.77"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2f96b10ec2560088a8e76961b00d47107b3a625fecb76dedb29ee7ccbf98235"
-[[package]]
-name = "lolcatrs"
-version = "0.1.0"
-dependencies = [
- "clap",
- "colored",
- "rand",
-]
-
[[package]]
name = "os_str_bytes"
version = "2.3.2"
diff --git a/Cargo.toml b/Cargo.toml
index 1a1be16..875e1b2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,9 +1,10 @@
[package]
-name = "lolcatrs"
+name = "dotacat"
version = "0.1.0"
authors = ["Stephen <stephen@scd31.com>"]
description = "Like lolcat, but fast"
edition = "2018"
+license = "MIT"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/README.md b/README.md
index 683f8ed..d81f4af 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,59 @@
-# Lolcat.rs
+# dotacat
-Why?
+dotacat is meant to be a replacement to lolcat.
+
+## Why?
+
+Speed!
```
$ time echo hi | lolcat
real 0m0.422s
user 0m0.393s
-sys 0m0.028s
+sys 0m0.028s
```
I use lolcat in my `.bashrc` file, so this amount of time is not ideal for me.
+In contrast:
+
+```
+time echo hi | dotacat
+
+real 0m0.045s
+user 0m0.030s
+sys 0m0.020s
+
+```
+
+## Why the name?
+
+Because Dota is better than LoL (According to people - I play neither)
+
+## Installation
+
+`cargo install dotacat`
+
+## Usage
+
+```
+USAGE:
+ dotacat [FLAGS] [OPTIONS] [files]...
+
+ARGS:
+ <files>... Files to concatenate(`-` for STDIN)
+
+FLAGS:
+ -h, --help Prints help information
+ -i, --invert Invert fg and bg
+ -V, --version Prints version information
+
+OPTIONS:
+ -F, --freq <freq> Rainbow frequency [default: 0.1]
+ -S, --seed <seed> Rainbow seed, 0 = random [default: 0.0]
+ -p, --spread <spread> Rainbow spread [default: 1.0]
+
+Examples:
+ dotacat f - g Output f's contents, then stdin, then g's contents.
+ fortune | dotacat Display a rainbow cookie.
+```
\ No newline at end of file
diff --git a/src/main.rs b/src/main.rs
index f649e5b..a1c4b13 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -8,7 +8,7 @@ mod lol;
#[derive(Clap)]
#[clap(author, about, version)]
#[clap(
- after_help = "Examples:\n\tlolcatrs f - g\tOutput f's contents, then stdin, then g's contents.\n\tfortune | lolcat\tDisplay a rainbow cookie."
+ after_help = "Examples:\n\tdotacat f - g\tOutput f's contents, then stdin, then g's contents.\n\tfortune | dotacat\tDisplay a rainbow cookie."
)]
struct CmdOpts {
#[clap(short = 'p', long, default_value = "1.0")]
--
GitLab