diff --git a/README.md b/README.md index 2625f42..e86202a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # BadWhiteSpace -If you're used to doing things on the terminal (like I am) +If you're used to doing things on the terminal (like I am) then having spaces in +your files is extremely annoying. This script will take all the files or +directories passed as arguments to it and replace the spaces with underscores +(`_`). + +## TODO + +- Create a new argument that allows the user to set the replacement + character(s). + +## License + +This project is licensed under the ZLib license (see the `LICENSE` file for more +information).