Skip to content

Commit 8961a84

Browse files
committed
docs: update README
1 parent 0cbdba6 commit 8961a84

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# proxxi
22

3-
**proxxi** is a .NET toolchain for **fetching proxies from plugins** and **serializing them into multiple output formats
4-
**.
3+
**proxxi** is a .NET toolchain for **fetching proxies from plugins** and **serializing them into multiple output formats**.
54

65
## Features
76

@@ -35,8 +34,7 @@ dotnet build -c Release --self-contained true -p:DebugType=embedded -o publish
3534

3635
## CLI usage
3736

38-
> The CLI provides a `fetch` command that loads configured plugins, fetches proxies, and writes them in the chosen
39-
> format.
37+
> The CLI provides a `fetch` command that loads configured plugins, fetches proxies, and writes them in the chosen format.
4038
4139
### Run
4240

@@ -62,16 +60,20 @@ export PROXXI_DIR="<ABSOLUTE_OR_RELATIVE_PATH>"
6260

6361
(If your shell is PowerShell on Windows, use `$env:PROXXI_DIR="..."`.)
6462

65-
Proxxi will initialize required directories/files on first run.
63+
> Proxxi will initialize required directories/files on the first run.
6664
6765
### Plugin configuration
6866

69-
Plugins are managed via a JSON-based configuration provider (stored under the Proxxi directory).
70-
You typically configure:
67+
You can manage plugins using the `plugin` command and its subcommands:
7168

72-
- which plugins are enabled
73-
- plugin IDs (with optional aliases)
74-
- plugin parameters
69+
- `plugin <PLUGIN-ID> info` - Show information about a plugin
70+
- `plugin <PLUGIN-ID> alias [ALIAS]` - Set or remove an alias for a plugin
71+
- `plugin <PLUGIN-ID> enable` - Enable a plugin
72+
- `plugin <PLUGIN-ID> disable` - Disable a plugin
73+
- `plugin <PLUGIN-ID> parameter <NAME> [VALUE]` - Set or remove a parameter for a plugin
74+
- `parameters` - List parameters for a plugin
75+
76+
You can also use the `plugins` command to list all installed plugins.
7577

7678
## Output formats
7779

@@ -102,7 +104,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
102104

103105
### Adding plugins
104106

105-
1. **Choose your Proxxi directory** (optional, but recommended for predictable paths):
107+
1. **Choose your Proxxi directory** (optional but recommended for predictable paths):
106108
```shell
107109
export PROXXI_DIR="<PATH_TO_PROXXI_DIR>"
108110
```
@@ -123,6 +125,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
123125
"path": "path/to/plugin/dll", // relative path from `$PROXXI_DIR/plugins/`
124126
"alias": "publisher", // optional
125127
"version": "1.0.0",
128+
"enabled": true,
126129
"params": {
127130
// plugin parameters if needed
128131
"param1": "value1",
@@ -132,7 +135,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
132135
]
133136
```
134137
135-
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that the plugin is add/enabled in the JSON config.
138+
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that the plugin is added/enabled in the JSON config.
136139
137140
## License
138141

0 commit comments

Comments
 (0)