KawAnime/README.md

<h1 align="center">KawAnime</h1>

<p align="center">
  <a href="http://forthebadge.com/">
    <img src="http://forthebadge.com/images/badges/built-with-love.svg"/>
  </a>
</p>

<p align="center">
  <a href="https://standardjs.com/">
    <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" />
  </a>
</p>

<p align="center">
  <a href="https://travis-ci.org/Kylart/KawAnime">
    <img src="https://travis-ci.org/Kylart/KawAnime.svg?branch=master" alt="Build Status">
  </a>
  <a href="https://codecov.io/gh/Kylart/KawAnime">
    <img src="https://codecov.io/gh/Kylart/KawAnime/branch/master/graph/badge.svg" alt="Codecov" />
  </a>
  <a href="https://opensource.org/licenses/MIT">
    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
  </a>
</p>

# Current situation

As you may know, nyaa.se is down for the moment (and maybe forever). _KawAnime_ was mostly based on nyaa so 
its behaviour had to change a bit.

_KawAnime_ is at the moment __fully based__ on HorribleSubs as for its downloading features. Some other fansub might be 
implemented in the feature to offer more choices.

# Features
Disclaimer : This is a software for otaku/anime-fans. Do not try if you're not prepared.

This software allows one to: 
* Be aware of the latest anime release.
* Download an anime (from ep X to ep Y) via Torrent (one would need a torrent client atm). One can also only get a 
list of torrent magnets to paste in a torrent client on a distant server.
* Get information from any anime (those come from myanimelist.net).
* Get anime-related news from MyAnimeList.net.
* Get seasonal releases information.
* Manage watch lists.
* More features are to come.

This is a software developed with Electron framework. It is still in development. 

## About OS
_KawAnime_ is completely cross-platform

Yet, if you find any problem, you can tell me anytime in the `issues` section.

## Installation
Be sure that you have Npm installed. You can find how to install npm (node) [here](https://nodejs.org/en/).
```
git clone https://github.com/Kylart/KawAnime
```
```
cd KawAnime/
```
```
npm install && npm run build
```

## Start
```
npm start
```

## Run in dev
```
npm run dev
```


## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request.

## TODOs
* Implement torrents with WebTorrent module.

## Thanks
Many thanks to 
* [Electron](https://electron.atom.io)
* [Nuxt](https://nuxtjs.org)
* [Vuetify](https://vuetifyjs.com)

## License
MIT License

Copyright (c) Kylart