Skip to content

Commit 3f14f71

Browse files
committed
Created readme
1 parent 4d763ac commit 3f14f71

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Java torrent file parser
2+
A simple java library that allows you to read the contents of a torrent file.
3+
4+
# Features
5+
6+
- Parse torrent file to a map
7+
- Parse torrent file to a Torrent object
8+
9+
### Torrent object structure
10+
11+
public class Torrent {
12+
String announce;
13+
Long totalLength = 0L;
14+
List<TorrentFile> files;
15+
String name;
16+
Long pieceLength;
17+
String pieces;
18+
boolean isSingleFile;
19+
boolean isPrivate;
20+
21+
// Optional fields
22+
List<List<String>> announceList;
23+
String creator;
24+
Long creationDate;
25+
String source;
26+
String comment;
27+
String encoding;
28+
Map<String, Object> azureusProperties;
29+
}

0 commit comments

Comments
 (0)