From 43aa0b6023cbe757d5df07bbc3001db7e51592bf Mon Sep 17 00:00:00 2001 From: Mwariri Clinton <131871502+mwarrc@users.noreply.github.com> Date: Wed, 4 Dec 2024 01:14:24 +0300 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0e65f19..572fb33 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ -# Proxyset 🛡️ +# Proxyset +Proxyset is a powerful proxy management tool designed primarily for Linux systems, with optimized support for Arch-based distributions. While intended to work across various Linux environments, full compatibility is not guaranteed for all distributions. Effortlessly configure, rollback, or monitor proxy configurations system-wide and for popular applications like Git, Pacman, and more. -**Proxyset** is a powerful CLI tool designed to simplify managing proxy settings on Linux. Effortlessly configure, rollback, or monitor proxy configurations system-wide and for popular applications like Git, Pacman, and more. +🐧 Compatibility Note: ---- +Best Performance: Arch Linux and Arch-based distributions +Recommended: systemd-based Linux distributions +Partial Support: Other Linux distributions may require system-specific adjustments ## ✨ Features - **Proxy Management**: Set and manage system-wide and application-specific proxy settings. @@ -12,7 +15,6 @@ - **Cross-Application Support**: Works with Git, NPM, Yarn, Pacman, and more. - **Silent & Transparent Operations**: Configure silent mode and set up a transparent proxy. ---- ## 🚀 Getting Started @@ -29,8 +31,17 @@ git clone https://github.com/mwarrc/proxyset.git cd proxyset chmod +x proxyset.sh ``` - ---- +### Installing as a Terminal App [optional] +1.Clone the repository +```bash +git clone https://github.com/yourusername/proxyset.git +cd proxyset +``` +2.Create a symbolic link and make it executable: +```bash +sudo ln -s "$(pwd)/proxyset.sh" /usr/local/bin/proxyset +sudo chmod +x /usr/local/bin/proxyset +``` ## 🛠️ Usage @@ -52,7 +63,6 @@ proxyset [command] [options] | `-s, --silent` | Run in silent mode. | | `--no-reboot` | Skip reboot prompt after setting.| ---- ## 🖥️ Examples @@ -69,7 +79,6 @@ proxyset [command] [options] proxyset status ``` ---- ## 📂 Configuration Details Proxyset modifies configurations for: @@ -81,7 +90,6 @@ Proxyset modifies configurations for: Backup files are automatically created during setup. ---- ## 🧑‍💻 Contributing Contributions are welcome! Feel free to: @@ -89,14 +97,13 @@ Contributions are welcome! Feel free to: 2. Create a new branch for your feature/bug fix. 3. Submit a pull request. ---- + ## 🎯 Roadmap - [ ] Add support for more applications. - [ ] Enhance transparent proxy functionality. - [ ] Create a GUI wrapper. ---- ---