From faf9ff260019c2d095051da5bfdb180823265d72 Mon Sep 17 00:00:00 2001
From: Abel `00z' Camarillo <abel00z@users.berlios.de>
Date: Fri, 20 Jun 2008 00:30:38 -0500
Subject: [PATCH] Add README

---
 README | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..cdaf757
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+anime_rename documentation.
+
+Suppose that you have the next directory:
+
+  $ ls anime_directory/
+
+  [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_08_[XVID+MP3][704x396][D1CD64FB].avi
+  [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_09_[XVID+MP3][704x396][29313464].avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_10_[4B243239].mkv
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_11_[xvid][99404FE2].avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_12_[xvid][4CB01B32].avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_13_[h264][243F017A].mkv
+
+
+And you want your files to be renamed this way:
+
+  [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_08_[XVID+MP3][704x396][D1CD64FB].avi
+          -> zoku_08.avi
+  [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_09_[XVID+MP3][704x396][29313464].avi
+          -> zoku_09.avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_10_[4B243239].mkv
+          -> zoku_10.mkv
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_11_[xvid][99404FE2].avi
+          -> zoku_11.avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_12_[xvid][4CB01B32].avi
+          -> zoku_12.avi
+  [volans]_Zoku_Sayonara_Zetsubou_Sensei_13_[h264][243F017A].mkv
+          -> zoku_13.mkv
+
+Anime rename will extract the ``index'' (the representative digits, by defaults
+    extracts 2 ``isolated' digits) of each file and its extension then use it to
+rename the file using a user-specified prefix.
+
+  $ anime_rename --prefix=zoku anime_directory/*Zoku*
+
+Will do the renaming duty.
+
+and now
+
+  $ ls anime_directory/
+
+  zoku_08.avi
+  zoku_09.avi
+  zoku_10.mkv
+  zoku_11.avi
+  zoku_12.avi
+  zoku_13.mkv
-- 
2.11.4.GIT