Skip to content

Commit 634e769

Browse files
committed
Update readme
1 parent cd10437 commit 634e769

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# Java torrent file parser
2-
A simple java library that allows you to read the contents of a torrent file.
1+
# Java Torrent File Parser
2+
A simple Java library that allows you to read the contents of a `.torrent` file.
33

44
# Features
5+
- Parse a .torrent file into a TorrentMetadata object
6+
- Parse a .torrent file into a Map<String, Object>
7+
- Get the info hash
8+
- Supports single-file and multi-file torrents
9+
- Access optional metadata fields such as trackers, comments, and creator info
510

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 {
11+
### TorrentMetadata object structure
12+
public class TorrentMetadata {
13+
Map<String, Object> otherValues;
1214
String announce;
1315
Long totalLength;
1416
List<TorrentFile> files;

0 commit comments

Comments
 (0)