From b42128ab2aea520a75f9b14ec2f07f4cc43250d9 Mon Sep 17 00:00:00 2001
From: Fred Israel <fredpublico@gmail.com>
Date: Thu, 11 Jul 2024 12:58:03 -0300
Subject: [PATCH] Better readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e69de29..7286bf0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,36 @@
+# Vimv - A Tool for Renaming Files in Bulk
+
+Vimv is a command-line tool that allows you to rename multiple files at once using your favorite text editor, Vim. It is designed to simplify the process of renaming files in bulk, making it easier to manage your files and directories.
+
+Inspired on [vimv](https://github.com/thameera/vimv), but I plan to add more features.
+
+## Features
+
+* Supports renaming multiple files at once
+* Utilizes Vim for editing file names, allowing for powerful text manipulation capabilities
+* Provides a user-friendly interface for confirming changes before applying them
+
+## Usage
+
+To use Vimv, simply run the command `vimv` followed by the list of files you want to rename. For example:
+```bash
+vimv file1.txt file2.txt file3.txt
+```
+This will open Vim with a list of the files, allowing you to edit their names as needed. Once you save and exit Vim, Vimv will apply the changes to the original files.
+
+## Installation
+
+### Homebrew
+    Work in progres...
+
+### Manually:
+You can download it from here: https://github.com/polvoazul/vimv-go/releases, then add to somewhere in your path.
+
+## Contributing
+
+Contributions to Vimv are welcome! If you have any suggestions or bug fixes, please open an issue or submit a pull request on the project's GitHub page.
+
+
+## License
+
+Vimv is licensed under the WTFPL (do whatever you want).
\ No newline at end of file