Merge pull request #1 from blackshadowsoftwareltd/remon

readme

Cargo.toml

@@ -3,6 +3,8 @@ name = "ultron"
 version = "0.1.0"
 edition = "2021"
 
+[lib]
+crate-type = ["cdylib", "staticlib", "rlib"]
 
 [dependencies]
 clap = { version = "4", features = ["derive"] }

readme.md

@@ -0,0 +1,83 @@
+# Ultron
+
+Welcome to the File/Dir Management CLI Tool! This tool is designed to help you manage files and directories on your system with ease using simple and efficient commands. It is built using Rust for optimal performance and reliability.
+
+## 🚀 Features
+
+- 📁 **List Files and Directories**: Quickly list all files and directories within a specified path.
+- 📝 **Create Files and Directories**: Easily create new files and directories.
+- 🗑️ **Delete Files and Directories**: Safely delete files and directories.
+- 🔀 **Move/Rename Files and Directories**: Move or rename files and directories.
+- 📋 **Copy Files and Dire
+
+## 🛠️ Installation
+
+To install this tool, you need to have Rust installed on your system. If you don't have Rust installed, you can get it from [rust-lang.org](https://www.rust-lang.org/).
+
+1. Clone the repository:
+
+    ```sh
+    gh repo clone santoshakil/ultron
+    ```
+
+2. Navigate to the project directory:
+
+    ```sh
+    cd ultron
+    ```
+
+3. Build the project:
+
+    ```sh
+    cargo build --release
+    ```
+
+4. Run the tool:
+
+    ```sh
+    ./target/release/ultron
+    ```
+
+## 📋 Usage
+
+Below are some example commands on how to use the File/Dir Management CLI Tool:
+
+- **Copy a file or directory**:
+
+    ```sh
+    ultron copy-all-files <source_path> <destination_path>
+    ```
+
+## 🤝 Contributing
+
+We welcome contributions from the community! If you're interested in contributing to the development of this tool, please follow these steps:
+
+1. Fork the repository on GitHub.
+2. Create a new branch from the `master` branch:
+
+    ```sh
+    git checkout -b feature/your-feature-name
+    ```
+
+3. Make your changes and commit them with descriptive messages.
+4. Push your changes to your forked repository:
+
+    ```sh
+    git push origin feature/your-feature-name
+    ```
+
+5. Open a pull request on GitHub and describe the changes you have made.
+
+### 🌟 Code of Conduct
+
+<!-- Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in this project. -->
+
+## 📄 License
+
+<!-- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. -->
+
+## 📬 Contact
+
+If you have any questions, suggestions, or feedback, feel free to open an issue or discussions on GitHub.
+
+Thank you for using the File/Dir Management CLI Tool!