Skip to content

Commit 8250100

Browse files
committed
docs: updated README
1 parent 2081d15 commit 8250100

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

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

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

56
## Features
67

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

3536
## CLI usage
3637

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

@@ -55,7 +57,7 @@ dotnet build -c Release --self-contained true -p:DebugType=embedded -o publish
5557
Proxxi supports configuring its working directory via an environment variable.
5658

5759
```shell
58-
export PROXXI_DIR="<ABSOLUTE_OR_RELATIVE_PATH>"
60+
export PROXXI_DIR="<PATH>"
5961
```
6062

6163
(If your shell is PowerShell on Windows, use `$env:PROXXI_DIR="..."`.)
@@ -71,7 +73,7 @@ You can manage plugins using the `plugin` command and its subcommands:
7173
- `plugin <PLUGIN-ID> enable` - Enable a plugin
7274
- `plugin <PLUGIN-ID> disable` - Disable a plugin
7375
- `plugin <PLUGIN-ID> parameter <NAME> [VALUE]` - Set or remove a parameter for a plugin
74-
- `parameters` - List parameters for a plugin
76+
- `plugin <PLUGIN-ID> parameters` - List parameters for a plugin
7577

7678
You can also use the `plugins` command to list all installed plugins.
7779

@@ -104,20 +106,23 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
104106

105107
### Adding plugins
106108

107-
1. **Choose your Proxxi directory** (optional but recommended for predictable paths):
108-
```shell
109-
export PROXXI_DIR="<PATH_TO_PROXXI_DIR>"
110-
```
111-
2. **Run proxxi** for initial `PROXXI_DIR` and subfolders and files (if is first run):
112-
```shell
113-
./proxxi --help
114-
```
115-
3. **Copy the plugin** into the `plugins` directory. Typically, this is the plugin `.dll` plus any required dependency
109+
For automatic adding plugins from `.pxp` package use the command:
110+
111+
```shell
112+
./proxxi install <PATH_TO_PLUGIN_PACKAGE>.pxp
113+
```
114+
115+
> This command unpackage `.pxp` package in to the plugins directory, and register in the plugins
116+
> configuration `plugins.json`.
117+
118+
#### Manual adding plugins
119+
120+
1. **Copy the plugin** into the `plugins` directory. Typically, this is the plugin `.dll` plus any required dependency
116121
files that ship with it (keep every plugin in its own folder for simplicity and conflict prevention):
117122
```shell
118-
cp -r <PLUGIN> "$PROXXI_DIR/plugins/"
123+
cp -r <PLUGIN_FOLDER> "$PROXXI_DIR/plugins/"
119124
```
120-
4. **Register/enable the plugin** in the Proxxi plugin configuration (JSON) under the Proxxi directory.
125+
2. **Register/enable the plugin** in the plugins configuration `plugins.json` under the Proxxi directory.
121126
```json5
122127
[
123128
{
@@ -135,7 +140,8 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
135140
]
136141
```
137142
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.
143+
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that
144+
> the plugin is added/enabled in the JSON config.
139145
140146
## License
141147

0 commit comments

Comments
 (0)