Skip to content

Commit 8e4beac

Browse files
authored
docs: add AI documentation (#574)
Signed-off-by: Pavel Pikta <pavel_pikta@epam.com>
1 parent 3a0f0fc commit 8e4beac

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ TorrServer is a program that allows users to view torrents online without the ne
3232
The core functionality of TorrServer includes caching torrents and subsequent data transfer via the HTTP protocol,
3333
allowing the cache size to be adjusted according to the system parameters and the user's internet connection speed.
3434

35+
## AI Documentation
36+
37+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/YouROK/TorrServer)
38+
3539
## Features
3640

3741
- Caching
@@ -191,7 +195,7 @@ To run the web server locally, just run
191195
yarn start
192196
```
193197

194-
More info at https://github.com/YouROK/TorrServer/tree/master/web#readme
198+
More info at <https://github.com/YouROK/TorrServer/tree/master/web#readme>
195199

196200
### Build
197201

@@ -222,6 +226,7 @@ cd server; swag init -g web/server.go
222226
# Documentation can be linted using
223227
swag fmt
224228
```
229+
225230
## API
226231

227232
### API Docs
@@ -240,6 +245,7 @@ The users data file should be located near to the settings. Basic auth, read mor
240245
"User2": "Pass2"
241246
}
242247
```
248+
243249
Note: You should enable authentication with -a (--httpauth) TorrServer startup option.
244250

245251
## Whitelist/Blacklist IP
@@ -267,7 +273,6 @@ local:127.0.0.1
267273
- [Boosty](https://boosty.to/yourok)
268274
- [TBank](https://www.tbank.ru/cf/742qEMhKhKn)
269275

270-
271276
## Thanks to everyone who tested and helped
272277

273278
- [anacrolix](https://github.com/anacrolix) Matt Joiner

0 commit comments

Comments
 (0)