From 979473c045be5a281dba1b0fbf7e7e2202d223ea Mon Sep 17 00:00:00 2001
From: Noah Hsu <i@nn.ci>
Date: Fri, 23 Sep 2022 14:22:20 +0800
Subject: [PATCH] docs: create `README.md`

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95c9ecc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## ipa_renamer
+
+A command line tool for renaming your ipa files quickly and easily.
+
+### Usage
+```bash
+ipa_renamer 0.0.1
+A command line tool for renaming your ipa files quickly
+
+USAGE:
+    ipa_renamer.exe [OPTIONS] <GLOB> [TEMPLATE]
+
+ARGS:
+    <GLOB>        file path pattern to rename
+    <TEMPLATE>    Name template for the new file [default: $raw@$CFBundleIdentifier]
+
+OPTIONS:
+    -h, --help           Print help information
+    -o, --out <OUT>      The dir to save the renamed files [default: renamed]
+    -t, --temp <TEMP>    The temp dir for the extracted ipa file [default: ./temp]
+    -V, --version        Print version information
+```
\ No newline at end of file