diff --git a/Cargo.toml b/Cargo.toml
index 0b4df85..ff99265 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,5 +1,5 @@
[package]
-name = "auto-sort"
+name = "RustyFilesort"
version = "0.1.1"
edition = "2021"
github = "lowpolycat1"
diff --git a/README.md b/README.md
index e1d6056..9b24a93 100644
--- a/README.md
+++ b/README.md
@@ -13,23 +13,23 @@
@@ -62,67 +62,49 @@
## About The Project
-[![Product Name Screen Shot][product-screenshot]](https://example.com)
+
-Here's a blank template to get started. To avoid retyping too much info, do a search and replace with your text editor for the following: `your_github_username`, `your_repo_name`, `your_twitter_handle`, `your_linkedin_username`, `your_email_client`, `your_email`, `your_project_title`, `your_project_description`, `your_project_license`
+RustyFilesort is a tool to automatically organize your downloads folder using Rust. It helps keep your files sorted and easy to find.
(back to top)
### Built With
-* [![Next][Next.js]][Next-url]
-* [![React][React.js]][React-url]
-* [![Vue][Vue.js]][Vue-url]
-* [![Angular][Angular.io]][Angular-url]
-* [![Svelte][Svelte.dev]][Svelte-url]
-* [![Laravel][Laravel.com]][Laravel-url]
-* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
-* [![JQuery][JQuery.com]][JQuery-url]
+[![Rust][Rust]][Rust-url]
(back to top)
## Getting Started
-This is an example of how you may give instructions on setting up your project locally.
-To get a local copy up and running follow these simple example steps.
+To get a local copy up and running follow these simple steps.
### Prerequisites
-This is an example of how to list things you need to use the software and how to install them.
-
-* npm
+- Rust
```sh
- npm install npm@latest -g
+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Installation
-1. Get a free API Key at [https://example.com](https://example.com)
-2. Clone the repo
+1. Clone the repo
```sh
- git clone https://github.com/your_github_username/your_repo_name.git
+ git clone https://github.com/LowPolyCat1/autosort_downloads
```
-3. Install NPM packages
+2. Build the project
```sh
- npm install
- ```
-
-4. Enter your API in `config.js`
-
- ```js
- const API_KEY = 'ENTER YOUR API';
+ cargo build --release
```
-5. Change git remote url to avoid accidental pushes to base project
+3. Run the executable
```sh
- git remote set-url origin your_github_username/your_repo_name
- git remote -v # confirm the changes
+ ./target/release/autosort_downloads
```
(back to top)
@@ -130,21 +112,21 @@ This is an example of how to list things you need to use the software and how to
## Usage
-Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+Use RustyFilesort to keep your downloads folder organized automatically. Simply run the executable and let it sort your files based on predefined rules.
-_For more examples, please refer to the [Documentation](https://example.com)_
+
(back to top)
## Roadmap
-* [ ] Feature 1
-* [ ] Feature 2
-* [ ] Feature 3
- * [ ] Nested Feature
+- [ ] Add support for custom sorting rules
+- [ ] Implement a GUI
+- [ ] Asynchronous Sorting
+- [x] Add support for multiple folders
-See the [open issues](https://github.com/your_github_username/your_repo_name/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/LowPolyCat1/autosort_downloads/issues) for a full list of proposed features (and known issues).
(back to top)
@@ -166,63 +148,46 @@ Don't forget to give the project a star! Thanks again!
### Top contributors
-
-
+
+
## License
-Distributed under the your_project_license. See `LICENSE.txt` for more information.
+Distributed under the MIT License. See `LICENSE.txt` for more information.
(back to top)
## Contact
-Your Name - [@your_twitter_handle](https://twitter.com/your_twitter_handle) -
+LowPolyCat1 - [@LowPolyCat1](https://twitter.com/LowPolyCat1) -
-Project Link: [https://github.com/your_github_username/your_repo_name](https://github.com/your_github_username/your_repo_name)
+Project Link: [https://github.com/LowPolyCat1/autosort_downloads](https://github.com/LowPolyCat1/autosort_downloads)
(back to top)
## Acknowledgments
-* []()
-* []()
-* []()
+- [othneildrew](https://github.com/othneildrew/Best-README-Template)
(back to top)
-[contributors-shield]: https://img.shields.io/github/contributors/your_github_username/your_repo_name.svg?style=for-the-badge
-[contributors-url]: https://github.com/your_github_username/your_repo_name/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/your_github_username/your_repo_name.svg?style=for-the-badge
-[forks-url]: https://github.com/your_github_username/your_repo_name/network/members
-[stars-shield]: https://img.shields.io/github/stars/your_github_username/your_repo_name.svg?style=for-the-badge
-[stars-url]: https://github.com/your_github_username/your_repo_name/stargazers
-[issues-shield]: https://img.shields.io/github/issues/your_github_username/your_repo_name.svg?style=for-the-badge
-[issues-url]: https://github.com/your_github_username/your_repo_name/issues
-[license-shield]: https://img.shields.io/github/license/your_github_username/your_repo_name.svg?style=for-the-badge
-[license-url]: https://github.com/your_github_username/your_repo_name/blob/master/LICENSE.txt
+[contributors-shield]: https://img.shields.io/github/contributors/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
+[contributors-url]: https://github.com/LowPolyCat1/autosort_downloads/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
+[forks-url]: https://github.com/LowPolyCat1/autosort_downloads/network/members
+[stars-shield]: https://img.shields.io/github/stars/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
+[stars-url]: https://github.com/LowPolyCat1/autosort_downloads/stargazers
+[issues-shield]: https://img.shields.io/github/issues/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
+[issues-url]: https://github.com/LowPolyCat1/autosort_downloads/issues
+[license-shield]: https://img.shields.io/github/license/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
+[license-url]: https://github.com/LowPolyCat1/autosort_downloads/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/your_linkedin_username
-[product-screenshot]: images/screenshot.png
-[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
-[Next-url]: https://nextjs.org/
-[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
-[React-url]: https://reactjs.org/
-[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
-[Vue-url]: https://vuejs.org/
-[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
-[Angular-url]: https://angular.io/
-[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
-[Svelte-url]: https://svelte.dev/
-[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
-[Laravel-url]: https://laravel.com
-[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
-[Bootstrap-url]: https://getbootstrap.com
-[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
-[JQuery-url]: https://jquery.com
+[linkedin-url]: https://linkedin.com/in/LowPolyCat1
+[Rust]: https://img.shields.io/badge/rust-000000?style=for-the-badge&logo=rust&logoColor=white
+[Rust-url]: https://www.rust-lang.org/