diff --git a/README.md b/README.md index e2e37b6..7d2544a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ # folderCracker-GUI -This app helps you delete all the folders under a directory and get all the files out. +![Folder Cracker Image](https://user-images.githubusercontent.com/36402030/142334220-e5ad0937-51a0-4ea4-8241-58c520ef1a87.png) -For example, you might have a folder with tons of sub folders. Some of the sub folders are empty, some others are not, but now you want to get all the files out and get rid of those messy folders. This app helps you do that! +This app helps you delete all the subfolders under a directory and get all the files out. +For example, you might have a folder with tons of subfolders. Some of the subfolders are empty, some others are not, but now you want to get all the files out and get rid of those messy folders. This app will delete all the subfolders and move all of the files into a new folder called "result" + +## Screenshots +![image](https://user-images.githubusercontent.com/36402030/142334782-4c4530eb-1eb6-4643-9476-f1f1168a8c6c.png) + + +## Some info +Platform: +- Computers with Java 11 or higher. + +Build with: +- Java 11 +- JavaFx +- Maven + +## Implemented Features +- Delete all the subfolders under the specified directory and move all the files into a folder called "result" +- Alert user and provide options of replacing or renaming the file when two files share the same name +![image](https://user-images.githubusercontent.com/36402030/142335441-6a00d054-d680-47be-8785-6cdf7494263e.png)