mirror of
https://git.v0l.io/Kieran/dtan.git
synced 2025-01-08 09:21:33 +00:00
chore: readme
This commit is contained in:
parent
998bd236f8
commit
e31e971435
49
README.md
49
README.md
@ -1,21 +1,36 @@
|
||||
# DTAN
|
||||
|
||||
**D**istributed **T**orrent **A**rchive on **N**ostr
|
||||
|
||||
This is a [NIP-35](https://github.com/nostr-protocol/nips/blob/master/35.md) client.
|
||||
|
||||
NIP-35 defines the event format as:
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 2003,›
|
||||
"content": "<long-description-pre-formatted>",
|
||||
"tags": [
|
||||
["title", "<torrent-title>"],
|
||||
["btih", "<bittorrent-info-hash>"],
|
||||
["t", "<top-level-tag>"],
|
||||
["t", "(optional)<second-level-tag>"],
|
||||
["t", ...other tags],
|
||||
["file", "<file-name>", "<file-size-in-bytes>"],
|
||||
["file", "<file-name>", "<file-size-in-bytes>"],
|
||||
["file", ...other files],
|
||||
["imdb", "(optional)<imdb-entry-id>"]
|
||||
]
|
||||
}
|
||||
{
|
||||
"kind": 2003,
|
||||
"content": "<long-description-pre-formatted>",
|
||||
"tags": [
|
||||
["title", "<torrent-title>"],
|
||||
["x", "<bittorrent-info-hash>"],
|
||||
["file", "<file-name>", "<file-size-in-bytes>"],
|
||||
["file", "<file-name>", "<file-size-in-bytes>"],
|
||||
["tracker", "udp://mytacker.com:1337"],
|
||||
["tracker", "http://1337-tracker.net/announce"],
|
||||
["i", "tcat:video,movie,4k"],
|
||||
["i", "newznab:2045"],
|
||||
["i", "imdb:tt15239678"],
|
||||
["i", "tmdb:movie:693134"],
|
||||
["i", "ttvdb:movie:290272"],
|
||||
["t", "movie"],
|
||||
["t", "4k"]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Top Level tags are usually the type of content like `"Video"` / `"Audio"` / `"Application"` and so on.
|
||||
## Future Plans
|
||||
|
||||
Second level tags are sub categories like `"Movies"` / `"CAD/CAM"`
|
||||
### Custom scraper relay
|
||||
|
||||
A relay which automatically clones torrent events from other relays.
|
||||
Simple docker image which can easily be deployed anywhere and will add another replica of torrent metadata.
|
||||
|
Loading…
Reference in New Issue
Block a user