Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mwarrc authored Dec 3, 2024
1 parent 3176cca commit 43aa0b6
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand All @@ -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

Expand All @@ -52,7 +63,6 @@ proxyset [command] [options]
| `-s, --silent` | Run in silent mode. |
| `--no-reboot` | Skip reboot prompt after setting.|

---

## πŸ–₯️ Examples

Expand All @@ -69,7 +79,6 @@ proxyset [command] [options]
proxyset status
```

---

## πŸ“‚ Configuration Details
Proxyset modifies configurations for:
Expand All @@ -81,22 +90,20 @@ Proxyset modifies configurations for:

Backup files are automatically created during setup.

---

## πŸ§‘β€πŸ’» Contributing
Contributions are welcome! Feel free to:
1. Fork the repository.
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.

---


---
Expand Down

0 comments on commit 43aa0b6

Please sign in to comment.