Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lgaticaq committed Mar 18, 2016
1 parent fcf8c38 commit 32c6b02
Showing 1 changed file with 43 additions and 56 deletions.
99 changes: 43 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,52 @@
anime-dl
========
# anime-dl

[![npm version](https://badge.fury.io/js/anime-dl.svg)](http://badge.fury.io/js/anime-dl)
[![npm version](https://img.shields.io/npm/v/anime-dl.svg?style=flat-square)](https://www.npmjs.com/package/anime-dl)
[![npm downloads](https://img.shields.io/npm/dm/anime-dl.svg?style=flat-square)](https://www.npmjs.com/package/anime-dl)
[![Build Status](https://img.shields.io/travis/lgaticaq/anime-dl.svg?style=flat-square)](https://travis-ci.org/lgaticaq/anime-dl)
[![dependency Status](https://img.shields.io/david/lgaticaq/anime-dl.svg?style=flat-square)](https://david-dm.org/lgaticaq/anime-dl#info=dependencies)
[![devDependency Status](https://img.shields.io/david/dev/lgaticaq/anime-dl.svg?style=flat-square)](https://david-dm.org/lgaticaq/anime-dl#info=devDependencies)
[![Join the chat at https://gitter.im/lgaticaq/anime-dl](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg?style=flat-square)](https://gitter.im/lgaticaq/anime-dl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

CLI for show and download anime from jkanime.net.
Search and get anime video url

Requirements
------------
## Installation

- [mpv](http://mpv.io/installation/)
- [wget](https://www.gnu.org/software/wget/)
- [vlc (optional)](http://www.videolan.org/vlc/#download)
- [mplayer2 (optional)](http://www.mplayer2.org/downloads/)
- [omxplayer (optional)](https://github.com/huceke/omxplayer/)


Install
-------

``` bash
[sudo] npm i -g anime-dl
```

Tested in GNU/Linux and OSX.
Default player is mpv.

Usage
-----

Interactive mode

``` bash
anime-dl
```bash
npm i -S anime-dl
```

Show a chapter of a anime from url.

``` bash
anime-dl -u [url]
## Use

[Try on Tonic](https://tonicdev.com/npm/anime-dl)
```js
import anime from 'anime-dl'

const keyword = 'one piece';
anime.searchAnime(keyword).then(console.log);
/*{
title: 'One Piece',
codeName: 'one-piece',
chapter: '732',
urls: [
'http://jkanime.net/stream/jkmedia/83b83090f08cbe7823cb0ed531f8cc72/0f40333b749a2a6d1bc5706accd73329/1/1de4451f8844a9c171830d25ff1cebbb/',
'http://jkanime.net/stream/jkmedia/83b83090f08cbe7823cb0ed531f8cc72/4f501d26373b56e0fe0351c1a6154bd4/1/1de4451f8844a9c171830d25ff1cebbb/',
'http://jkanime.net/stream/jkmedia/83b83090f08cbe7823cb0ed531f8cc72/ea38fc252cc488c0c1149875b8694f87/1/1de4451f8844a9c171830d25ff1cebbb/'
]
}*/
```

Show a chapter of a anime. Example of title: dragon-ball

``` bash
anime-dl -c [number] -t [title-anime]
```

Show a chapter of a anime in vlc

``` bash
anime-dl -c [number] -t [title-anime] -v
```

Download a chapter of a anime. Example of title: dragon-ball. Require wget

``` bash
anime-dl -c [number] -t [title-anime] -f [filename]
```

Download a chapter from url. Require wget

``` bash
anime-dl -u [url] -f [filename]
const uri = 'http://jkanime.net/one-piece/732/';
anime.searchAnime(uri).then(console.log);
/*[
{ url: 'http://jkanime.net/one-piece/', name: 'One Piece' },
{ url: 'http://jkanime.net/one-piece-taose-kaizoku-ganzack/', name: 'One Piece: Taose! Kaizoku Ganzack' },
{ url: 'http://jkanime.net/one-piece-romance-dawn/', name: 'One Piece: Romance Dawn' },
{ url: 'http://jkanime.net/one-piece-strong-world-episode-0/', name: 'One Piece: Strong World Episode 0' },
{ url: 'http://jkanime.net/one-piece-recap/', name: 'One Piece Recap' },
{ url: 'http://jkanime.net/one-piece-episode-of-nami/', name: 'One Piece: Episode of Nami' },
{ url: 'http://jkanime.net/one-piece-episode-of-luffy-hand-island-no-bouken/', name: 'One Piece: Episode of Luffy - Hand Island no Bouken' },
{ url: 'http://jkanime.net/dream-9-toriko-one-piece-dragon-ball-z-super-collaboration-special/', name: 'Toriko & One Piece & Dragon Ball Z Super Collaboration' },
{ url: 'http://jkanime.net/one-piece-film-z/', name: 'One Piece Film Z' },
{ url: 'http://jkanime.net/one-piece-special-glorious-island/', name: 'One Piece Special: Glorious Island' }
]*/
```

0 comments on commit 32c6b02

Please sign in to comment.