Skip to content

Commit

Permalink
change name and add example
Browse files Browse the repository at this point in the history
  • Loading branch information
atombarel committed Aug 30, 2019
1 parent 1feb34c commit a8a9aa1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Installation
------------

Like every other npm package, run the command
`npm install addic7ed-api`
`npm install addic7ed-api-updated`


Usage example
Expand All @@ -18,7 +18,7 @@ Search completed subtitles file for South Park season 19 episode 6.
Download and save the first result.

```javascript
var addic7edApi = require('addic7ed-api');
var addic7edApi = require('addic7ed-api-updated');
addic7edApi.search('South Park', 19, 6).then(function (subtitlesList) {
var subInfo = subtitlesList[0];
if (subInfo) {
Expand All @@ -32,6 +32,24 @@ addic7edApi.getShowTitles().then(function(showTitlesList){
});
```

Search completed subtitles file for Suits season 9 episode 1 in french.
Download and save the first result.

```javascript
var addic7edApi = require('addic7ed-api-updated');
addic7edApi.search('Suits', 9, 1, 'fre').then(function (subtitlesList) {
var subInfo = subtitlesList[0];
if (subInfo) {
addic7edApi.download(subInfo, './Suits.S09E01.srt').then(function () {
console.log('Subtitles file saved.');
});
}
});
addic7edApi.getShowTitles().then(function(showTitlesList){
console.log('All show titles available:', showTitlesList);
});
```


API functions
-------------
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "addic7ed-api",
"version": "1.8.2",
"name": "addic7ed-api-updated",
"version": "1.8.4",
"description": "API to search and download subtitles files from addic7ed.com",
"main": "index.js",
"dependencies": {
Expand All @@ -15,7 +15,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/same31/addic7ed-api.git"
"url": "https://github.com/atombarel/addic7ed-api.git"
},
"keywords": [
"addic7ed",
Expand All @@ -25,10 +25,10 @@
"search",
"download"
],
"author": "Matthieu Mitrani",
"author": "Andrea Tombarel",
"license": "MIT",
"bugs": {
"url": "https://github.com/same31/addic7ed-api/issues"
"url": "https://github.com/atombarel/addic7ed-api/issues"
},
"homepage": "https://github.com/same31/addic7ed-api"
"homepage": "https://github.com/atombarel/addic7ed-api"
}

0 comments on commit a8a9aa1

Please sign in to comment.