Updated README in regards to #2 and #6

This commit is contained in:
Baipyrus 2024-10-01 20:39:14 +02:00 committed by GitHub
parent d1f88f54e1
commit 77e2fa01ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -32,10 +32,13 @@ irm 'https://raw.githubusercontent.com/Baipyrus/ProxySwitcher/main/install.ps1'
Generally, the [Installation](#installation) step will install both the program, Generally, the [Installation](#installation) step will install both the program,
its assets, and a shortcut for the Windows Startmenu for your current userprofile. its assets, and a shortcut for the Windows Startmenu for your current userprofile.
You *could* go into the program directory (`C:\Users\[Username]\AppData\Local\Programs\ProxySwitcher\`) Additionally, the program will also be added to the user's `%PATH%` Variable and
manually and run the program from your CLI in there, but it is recommended to simply will this be executable from within the command-line. However, you will either need
use the program in system tray or directly via code. This latter option will be explained to navigate into the program directory (`C:\Users\[Username]\AppData\Local\Programs\ProxySwitcher\`)
next: manually or specify a path to any directory containing configuration files using
the flag `-c, --configs string configurations path (default "configs/")`.
To keep it simple, it is still recommended to use the program in system tray or
directly via code. This latter option will be explained next:
- Clone the repository: - Clone the repository:
@ -48,26 +51,38 @@ next:
- **set**: Enable all saved proxies including system proxy. - **set**: Enable all saved proxies including system proxy.
```powersell ```powersell
# .\ProxySwitcher.exe set
go run . set go run . set
``` ```
- **unset**: Disable all saved proxies including system proxy. - **unset**: Disable all saved proxies including system proxy.
```powersell ```powersell
# .\ProxySwitcher.exe unset
go run . unset go run . unset
``` ```
- **save**: Saves a new configuration to set a proxy for. - **save**: Saves a new configuration to set a proxy for.
```powersell ```powersell
# .\ProxySwitcher.exe save
go run . save
```
- **debug**: Prints all proxy configurations after generating corresponding commands.
```powersell
# .\ProxySwitcher.exe debug
go run . save go run . save
``` ```
### Configuration ### Configuration
The programs for which the proxy settings should be managed are stored in a `configs.json` The programs for which the proxy settings should be managed are stored in [`configs/`](https://github.com/Baipyrus/ProxySwitcher/tree/main/configs),
file, which can be modified directly or through the `save` command. For examples, wherein you can then create a JSON file per command group. These files can easily
please take a look at the [default config](./configs.json) or at the following block: be modified directly or generated through the `save` command. For examples,
please take a look at the [default config](https://github.com/Baipyrus/ProxySwitcher/tree/main/configs)
or at the following block:
```js ```js
[ [