Skip to content

Commit 8c58fef

Browse files
committed
docs: update README
1 parent 049dff1 commit 8c58fef

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
@@ -45,28 +45,34 @@ Currently supported target are:
4545

4646
## Usage
4747

48-
[Install](./docs/install.md) cgtproxy,
49-
then enable and start the systemd service by:
48+
1. [Install](./docs/install.md) cgtproxy;
5049

51-
```bash
52-
# Run the line below if you have old cgtproxy running as systemd service already.
53-
# systemctl daemon-reload
54-
systemctl enable --now cgtproxy.service
55-
```
50+
2. Enable and start the systemd service by:
5651

57-
You could check the nft rules generated by default (empty) configuration by:
52+
```bash
53+
# Run the line below if you have old cgtproxy running as systemd service already.
54+
# systemctl daemon-reload
55+
systemctl enable --now cgtproxy.service
56+
```
57+
58+
You could check the nft rules generated by default (empty) configuration by:
5859

59-
```bash
60-
sudo nft list ruleset
61-
```
60+
```bash
61+
sudo nft list ruleset
62+
```
6263

63-
Write your own configuration file according to the [configuration guide],
64-
place it on /etc/cgtproxy/config.yaml then restart systemd service by:
64+
The nft rule set is generated with [the builtin default configuration].
6565

66-
```bash
67-
systemctl restart cgtproxy.service
68-
```
66+
3. Write your own configuration file according to the [configuration guide],
67+
place it at `/etc/cgtproxy/config.yaml`
68+
69+
4. Restart systemd service by:
70+
71+
```bash
72+
systemctl restart cgtproxy.service
73+
```
6974

75+
[the builtin default configuration]: https://pkg.go.dev/github.com/black-desk/cgtproxy/pkg/cgtproxy/config#pkg-constants
7076
[configuration guide]: ./docs/configuration.md
7177

7278
## Tips

0 commit comments

Comments
 (0)