Skip to content

Commit e2a08b7

Browse files
chore(docs): updates readme with correct information
1 parent 41ac463 commit e2a08b7

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
# parse-torrent-title
22

3-
![Continuous integration](https://github.com/clement-escolano/parse-torrent-title/workflows/Continuous%20integration/badge.svg)
4-
5-
This package helps you extract information from a torrent name such as language, resolution and codec.
3+
This package helps you extract information from a torrent name such as language, resolution and codec. This was forked and updated from [TheBeastLT's Fork](https://github.com/TheBeastLT/parse-torrent-title) of [parse-torrent-title](https://github.com/TheBeastLT/parse-torrent-title). While the fork is quite good, there are many instances where it has failed, so we decided to modify it ourselves. Most new regexes come from [dreulavelle's PTT](https://github.com/dreulavelle/PTT), which is a rewrite of parse-torrent-title in Python.
64

75
## Installation
86

97
You can install it using npm:
108
```bash
11-
npm install parse-torrent-title
9+
npm install https://github.com/TorBox-App/parse-torrent-title.git
1210
```
1311
You should use Node 8.0 or higher to use this package.
1412

1513
## Usage
1614

1715
A simple usage is as follows:
1816
```javascript
19-
const ptt = require("parse-torrent-title");
17+
import ptt from "parse-torrent-title";
2018
const information = ptt.parse("Game.of.Thrones.S01E01.720p.HDTV.x264-CTU");
2119

2220
console.log(information.title); // Game of Thrones

0 commit comments

Comments
 (0)