Skip to content

Commit 91bd370

Browse files
authored
docs: update formatting and fix CI badge link (#602)
- update GitHub Actions workflow badge to docker_image.yml - fix code block spacing in installation examples - standardize Development section heading levels Signed-off-by: Pavel Pikta <[email protected]>
1 parent af5f309 commit 91bd370

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
<a href="https://github.com/YouROK/TorrServer/issues">
1919
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="CodeFactor" />
2020
</a>
21-
<a href="https://github.com/YouROK/TorrServer/actions/workflows/github-actions-docker.yml" rel="nofollow">
22-
<img src="https://img.shields.io/github/actions/workflow/status/YouROK/TorrServer/github-actions-docker.yml?logo=Github" alt="Build" />
21+
<a href="https://github.com/YouROK/TorrServer/actions/workflows/docker_image.yml" rel="nofollow">
22+
<img src="https://img.shields.io/github/actions/workflow/status/YouROK/TorrServer/docker_image.yml?logo=Github" alt="Build" />
2323
</a>
2424
<a href="https://github.com/YouROK/TorrServer/tags" rel="nofollow">
2525
<img alt="GitHub tag (latest SemVer pre-release)" src="https://img.shields.io/github/v/tag/YouROK/TorrServer?include_prereleases&label=version"/>
@@ -79,30 +79,43 @@ curl -s https://raw.githubusercontent.com/YouROK/TorrServer/master/installTorrSe
7979
**Command-line examples:**
8080

8181
- Install a specific version:
82+
8283
```bash
8384
sudo bash ./installTorrServerLinux.sh --install 135 --silent
8485
```
86+
8587
- Update to latest version:
88+
8689
```bash
8790
sudo bash ./installTorrServerLinux.sh --update --silent
8891
```
92+
8993
- Reconfigure settings interactively:
94+
9095
```bash
9196
sudo bash ./installTorrServerLinux.sh --reconfigure
9297
```
98+
9399
- Check for updates:
100+
94101
```bash
95102
sudo bash ./installTorrServerLinux.sh --check
96103
```
104+
97105
- Downgrade to a specific version:
106+
98107
```bash
99108
sudo bash ./installTorrServerLinux.sh --down 135
100109
```
110+
101111
- Remove/uninstall:
112+
102113
```bash
103114
sudo bash ./installTorrServerLinux.sh --remove --silent
104115
```
116+
105117
- Change the systemd service user:
118+
106119
```bash
107120
sudo bash ./installTorrServerLinux.sh --change-user root --silent
108121
```
@@ -234,7 +247,7 @@ services:
234247

235248
## Development
236249

237-
#### Go server
250+
### Go server
238251

239252
To run the Go server locally, just run
240253

@@ -243,7 +256,7 @@ cd server
243256
go run ./cmd
244257
```
245258

246-
#### Web development
259+
### Web development
247260

248261
To run the web server locally, just run
249262

0 commit comments

Comments
 (0)