diff --git a/README.md b/README.md index 1f954a2..8c6dbd0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ -# crunchbang +# Crunchbang Scripts -A collection of useful bash scripts to enhance your command-line experience and automate common tasks. +A collection of utility scripts for macOS system management and automation. -## 🚀 Overview +## Scripts -This repository contains a curated set of bash scripts that can help streamline your workflow, automate repetitive tasks, and make your command-line experience more efficient. Each script is well-documented and designed to be easily integrated into your daily routine. +### `dock.sh` +Manages macOS Dock settings. -## 📦 Installation - -1. Clone the repository: ```bash -git clone https://git.okseby.com/okseby/crunchbang.git +./scripts/dock.sh [check|reset] +``` +- `check` - Show current Dock tile size +- `reset` - Reset Dock to default settings + +### `movefiles.sh` +Moves files from one location to another based on file type. + +```bash +./scripts/movefiles.sh [source_dir] [destination_dir] +``` +- `source_dir` - Source directory containing files to move +- `destination_dir` - Destination directory for organized files + +## Installation + +1. Clone this repository: +```bash +git clone https://github.com/yourusername/crunchbang.git cd crunchbang ``` @@ -19,52 +35,24 @@ cd crunchbang chmod +x scripts/*.sh ``` -3. (Optional) Add the scripts directory to your PATH: +## Usage + +All scripts are located in the `scripts` directory. Each script has built-in help that can be accessed by running it without arguments. + +Example: ```bash -echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.bashrc -# or for zsh -echo 'export PATH="$PATH:$(pwd)/scripts"' >> ~/.zshrc +./scripts/dock.sh ``` -## 🛠️ Available Scripts +## Requirements -Each script in this collection serves a specific purpose. Here's a brief overview of what's available: +- macOS +- Bash or compatible shell -- `scripts/`: Directory containing all the bash scripts - - (Scripts will be listed here as they are added) +## License -## 📖 Usage +MIT License - feel free to use and modify these scripts as needed. -Each script includes its own documentation and usage instructions. You can view the help for any script by running: +## Contributing -```bash -./scripts/script-name.sh --help -``` - -## 🤝 Contributing - -Contributions are welcome! If you have a useful bash script that you'd like to share: - -1. Fork the repository -2. Create a new branch for your feature -3. Add your script to the `scripts/` directory -4. Update the README with information about your script -5. Submit a pull request - -Please ensure your scripts: -- Include proper documentation -- Follow bash best practices -- Include error handling -- Are tested thoroughly - -## 📝 License - -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. - -## ⭐ Support - -If you find these scripts useful, please consider giving the repository a star! For issues, feature requests, or questions, please open an issue in the GitLab repository. - ---- - -Made with ❤️ by [Your Name] +Feel free to submit issues and enhancement requests!