readme

README.md

@@ -1,3 +1,25 @@
 # term-owo
 
-owoify text from the terminal
+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`