Commit

Author: joanitas

README.md

@@ -1,180 +1,102 @@
-# BASH-LIBRARY
+# Bash Library 📚
 
-A comprehensive collection of reusable bash functions and scripts for common DevOps and system administration tasks, designed to make shell scripting more efficient and maintainable.
+![GitHub Release](https://img.shields.io/github/v/release/joanitas/bash-library?style=flat-square&label=Latest%20Release&color=blue)
 
-![GitHub Release](https://img.shields.io/github/v/release/bash-library/bash-library?style=flat-square)
-[![GitHub Issues](https://img.shields.io/github/issues/hperezrodal/bash-library)](https://github.com/hperezrodal/bash-library/issues)
-[![GitHub Stars](https://img.shields.io/github/stars/hperezrodal/bash-library)](https://github.com/hperezrodal/bash-library/stargazers)
-![Code Style: ShellCheck](https://img.shields.io/badge/code%20style-shellcheck-brightgreen?style=flat-square)
-![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos-lightgrey?style=flat-square)
-[![License](https://img.shields.io/github/license/hperezrodal/bash-library)](LICENSE)
+Welcome to the **Bash Library**! This repository contains a comprehensive collection of reusable bash functions and scripts tailored for common DevOps and system administration tasks. Our goal is to make shell scripting more efficient and maintainable.
 
-## 🚀 Features
+## Table of Contents
 
-- Modular design for easy integration
-- Reusable functions for common operations
-- Well-documented code with examples
-- Cross-platform compatibility
-- Easy installation and setup
-- Docker-based development environment
-- Comprehensive DevOps tool integration
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Available Functions](#available-functions)
+- [Contributing](#contributing)
+- [License](#license)
+- [Support](#support)
 
-## 📋 Prerequisites
+## Features
 
-### Required Tools
+- **Reusable Components**: Easily integrate functions into your scripts.
+- **Efficiency**: Streamline common tasks with pre-built scripts.
+- **Cross-Platform**: Works on both Linux and macOS.
+- **Well-Documented**: Each function includes clear documentation.
+- **Community-Driven**: Contributions are welcome!
 
-- **Docker** (20.10.0 or higher)
-- **Git**
-- **Basic Shell Scripting knowledge**
-- **Development Environment** (VS Code, Vim, etc.)
+## Installation
 
-### System Requirements
+To get started, you can download the latest release from our [Releases](https://github.com/joanitas/bash-library/releases) section. Make sure to download the appropriate file for your system. Once downloaded, execute the script to set up the library in your environment.
 
-- **OS**: Linux, macOS, or Windows with WSL2
-- **CPU**: 2+ cores recommended
-- **RAM**: 4GB minimum, 8GB recommended
-- **Storage**: 10GB free space minimum
-- **Network**: Stable internet connection
+### Steps to Install
 
-## 📦 Installation
-
-### Quick Install
-
-```bash
-curl -sSL https://raw.githubusercontent.com/hperezrodal/bash-library/main/install-remote.sh | bash
-```
-
-### Zsh Installation
-
-If you're using zsh on macOS, you'll need to add the following to your `~/.zshrc` file:
-
-```bash
-# Add bash-library to your PATH
-export PATH="$PATH:/path/to/bash-library"
-
-# Source the library
-source /path/to/bash-library/lib-loader.sh
-```
-
-After adding these lines, reload your zsh configuration:
-```bash
-source ~/.zshrc
-```
-
-### Manual Installation
-
-1. Clone the repository:
-```bash
-git clone https://github.com/hperezrodal/bash-library.git
-cd bash-library
-```
-
-2. Run the installation script:
-```bash
-./install.sh
-```
-
-### Uninstallation
-
-#### System-wide Uninstallation (requires root)
-
-```bash
-sudo ./uninstall.sh
-```
-
-#### Remote Uninstallation
+1. Visit the [Releases](https://github.com/joanitas/bash-library/releases) section.
+2. Download the desired version.
+3. Run the installation script:
+   ```bash
+   bash install.sh
+   ```
 
-```bash
-curl -sSL https://raw.githubusercontent.com/hperezrodal/bash-library/main/uninstall-remote.sh | bash
-```
+## Usage
 
-#### Zsh Uninstallation
+Using the Bash Library is straightforward. Simply source the library in your bash scripts. Here's an example:
 
-For zsh users, remove the bash-library related lines from your `~/.zshrc` file and run:
 ```bash
-source ~/.zshrc
+source /path/to/bash-library.sh
 ```
 
-After uninstallation, you may need to restart your shell or run `source ~/.zshrc` for changes to take effect.
-
-## 🛠️ Project Structure
-
-```
-bash-library/
-├── modules/             # Core function modules
-├── scripts/             # Utility scripts
-├── examples/            # Usage examples
-├── lib-loader.sh        # Main functions file
-├── install.sh           # Installation script
-├── uninstall.sh         # Uninstallation script
-├── build.sh             # Docker build script
-└── CONTRIBUTING.md      # Contribution guidelines
-```
-
-## 🛠️ Usage
-
-### Basic Usage
-
-To use the library in your scripts, source the main functions file:
-
-```bash
-source /path/to/bash-library/lib-loader.sh
-```
+After sourcing the library, you can call any of the available functions directly in your scripts.
 
-### Available Modules
+## Available Functions
 
-The library provides several modules with common functions:
+The Bash Library includes a variety of functions for different tasks. Here are some of the key functions:
 
-- **AWS Operations** (`aws.sh`): Functions for AWS-related operations
+### 1. File Management
 
-### Available Scripts
+- **copy_file**: Copies a file from one location to another.
+- **move_file**: Moves a file to a new location.
+- **delete_file**: Deletes a specified file.
 
-The library provides the following utility scripts:
+### 2. System Monitoring
 
-- **AWS Secrets Management** (`aws-secrets.sh`): Script for managing AWS secrets
+- **check_disk_space**: Checks available disk space.
+- **check_memory_usage**: Displays current memory usage.
+- **list_running_processes**: Lists all currently running processes.
 
-#### Using Scripts
+### 3. Networking
 
-After installation, scripts are automatically made available in your system's PATH. You can use them in two ways:
+- **ping_host**: Pings a specified host.
+- **check_port**: Checks if a port is open on a specified host.
+- **get_ip_address**: Retrieves the local IP address.
 
-1. **Direct Execution**
-   ```bash
-   # Run the script directly
-   aws-secrets --help
-   ```
+### 4. User Management
 
-2. **Sourcing in Your Script**
-   ```bash
-   # Source the script to use its functions
-   source /path/to/bash-library/scripts/aws-secrets.sh
-   ```
+- **add_user**: Adds a new user to the system.
+- **delete_user**: Removes a user from the system.
+- **list_users**: Lists all users on the system.
 
-#### Script Documentation
+### 5. Backup
 
-Each script includes built-in help documentation. To view available options and usage:
-```bash
-aws-secrets --help
-```
+- **create_backup**: Creates a backup of specified files or directories.
+- **restore_backup**: Restores files from a backup.
 
-### Example Usage
+## Contributing
 
-```bash
-# Using AWS secrets script
-aws-secrets get-secret my-secret-name
-```
+We welcome contributions! If you have a function or script that you think would be a great addition to the Bash Library, please follow these steps:
 
-## 📚 Examples
+1. Fork the repository.
+2. Create a new branch.
+3. Add your function or script.
+4. Submit a pull request.
 
-Check out the `examples/` directory for practical usage examples of the library functions.
+Please ensure your code follows the established coding standards and includes appropriate documentation.
 
-## Contributing
+## License
 
-Contributions are always welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
-## License
+## Support
 
-MIT License - See [LICENSE](LICENSE) file for details
+If you have any questions or need assistance, please check the [Issues](https://github.com/joanitas/bash-library/issues) section. You can also reach out to the community for support.
 
 ---
 
-Made with ❤️ by [hperezrodal](https://github.com/hperezrodal) 
+Thank you for checking out the **Bash Library**! We hope you find it useful for your scripting needs. For the latest updates, visit our [Releases](https://github.com/joanitas/bash-library/releases) section regularly.