Skip to content

Commit

Permalink
Better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
polvoazul committed Jul 11, 2024
1 parent 4d8763c commit b42128a
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit b42128a

Please sign in to comment.