KawAnime/README.md

74 lines
1.8 KiB
Markdown
Raw Normal View History

2017-05-02 22:37:29 +00:00
# Current situation
As you may know, nyaa.se is down for the moment (and maybe forever). _KawAnime_ was mostly based on nyaa so
at this moment two features aren't working : __Latest releases__ and __Downloader__.
I am going to fix this in the days to come. But _KawAnime_ will then only be able to fetch torrents from horriblesubs
.info
# _KawAnime_
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.
2017-04-15 14:16:14 +00:00
* 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).
2016-12-10 15:27:06 +00:00
* Get anime-related news from MyAnimeList.net.
2017-02-07 10:19:29 +00:00
* Get seasonal releases information.
2017-04-15 14:16:14 +00:00
* Manage watch lists.
2017-02-07 10:19:29 +00:00
* More features are to come.
This is a software developed with Electron framework. It is still in development.
2016-11-27 09:49:17 +00:00
## About OS
_KawAnime_ is completely cross-platform
2017-02-07 10:19:29 +00:00
Yet, if you find any problem, you can tell me anytime in the `issues` section.
2016-11-27 09:49:17 +00:00
2016-11-21 14:33:22 +00:00
## Installation
Be sure that you have Npm installed. You can find how to install npm (node) [here](https://nodejs.org/en/).
2016-11-21 14:33:22 +00:00
```
2016-11-21 14:37:04 +00:00
git clone https://github.com/Kylart/KawAnime
2016-11-21 14:33:22 +00:00
```
```
2016-11-21 14:37:04 +00:00
cd KawAnime/
2016-11-21 14:33:22 +00:00
```
```
2017-04-15 14:16:14 +00:00
npm install && npm run build
2016-11-21 14:33:22 +00:00
```
2016-12-10 15:27:06 +00:00
## Start
```
npm start
```
2017-04-15 14:16:14 +00:00
## Run in dev
```
npm run dev
```
2016-12-10 15:27:06 +00:00
2016-11-21 14:33:22 +00:00
## 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
2017-04-15 14:16:14 +00:00
* Implement torrents with WebTorrent module.
## Thanks
Many thanks to
* [Electron](https://electron.atom.io)
* [Nuxt](https://nuxtjs.org)
* [Vuetify](https://vuetifyjs.com)
2016-11-21 14:33:22 +00:00
## License
MIT License
Copyright (c) Kylart