chore: add minimal detail to readme

cl0wng1rl · Jan 19, 2024 · 6b2e3b6 · 6b2e3b6
1 parent 2316713
commit 6b2e3b6
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,11 @@
-# csu [![CI](https://github.com/cl0wng1rl/csu/actions/workflows/ci.yml/badge.svg)](https://github.com/cl0wng1rl/csu/actions/workflows/ci.yml) [![codecov](https://codecov.io/github/cl0wng1rl/csu/branch/main/graph/badge.svg?token=RfkXLINOJV)](https://codecov.io/github/cl0wng1rl/csu)
+# csu [![CI](https://github.com/cl0wng1rl/csu/actions/workflows/ci.yml/badge.svg)](https://github.com/cl0wng1rl/csu/actions/workflows/ci.yml) [![codecov](https://codecov.io/github/cl0wng1rl/csu/branch/main/graph/badge.svg?token=RfkXLINOJV)](https://codecov.io/github/cl0wng1rl/csu)
+
+## Case Switch Util
+
+`csu` is a command line tool designed to make switching the case of text easy.
+
+### Example
+
+`% csu "hello world" -c upper`
+
+`> HELLO WORLD`