From 6b50670fef8f4e14c0c7f02cfb7aa63914175987 Mon Sep 17 00:00:00 2001 From: alfie Date: Fri, 19 Apr 2024 15:30:32 +0100 Subject: [PATCH] readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e97d50..ad53d31 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # term-owo -owoify text from the terminal \ No newline at end of file +owoify text from the terminal + +# installation + +### install from source + +download the latest release [here](https://git.alfieking.dev/acetheking987/term-owo/releases) or clone the repository and run `pip install .` in downloaded folder + +### install from repo + +run `pip install --index-url https://git.alfieking.dev/api/packages/acetheking987/pypi/simple/ cmdline-owo` in terminal + +# usage + +from terminal run `owo` to owoify text + +use the `-p` flag to use a pipe as input + +### examples + +`owo "hello world"` -> `hewwo wowwd` + +`echo "hello world" | owo -p` -> `hewwo wowwd`