chore(readme): Add disclaimer
[plugin.video.netflix.git] / README.md
1 # plugin.video.netflix
2
3 ## Netflix Plugin for Kodi 18
4
5 ###Disclaimer
6 -------------
7 This plugin is not officially commisioned/supported by Netflix.
8 The trademark "Netflix" is registered by "Netflix, Inc."
9
10 ###Prerequisites
11 ----------------
12
13 - Kodi 18 [agile build](https://github.com/FernetMenta/kodi-agile)
14 - Libwidevine 1.4.8.962 (A german description how to get/install it, can be found [here](https://www.kodinerds.net/index.php/Thread/51486-Kodi-17-Inputstream-HowTo-AddOns-f%C3%BCr-Kodi-17-ab-Beta-6-aktuelle-Git-builds-Updat/))
15 - Inputstream.adaptive [agile branch build](https://github.com/liberty-developer/inputstream.adaptive/tree/agile)
16
17 ###Functionality
18 ----------------
19 - Multiple profiles
20 - Search Netflix (incl. suggestions)
21 - Netflix categories, recommendations, "my list" & continue watching
22 - Rate show/movie
23 - Add & remove to/from "my list"
24 - Export of complete shows & movies in local database (custom library folder can be configured, by default the .strm files are stored in `userdata/addon_data/plugin.video.netflix` )
25
26 ###ToDo
27 ----------------
28
29 > Note: Those Todos are considered enhancements, they´re not issues, nor they prevent the usage of the plugin for everyday business
30
31 If you feel, you´d like to contribute to this plugin or directly work on one of these items,
32 please open an issue & we can provide you with some help to get started
33
34 - [ ] Add missing meta data for episodes/seasons (Cast, bookmark position, etc.)
35 - [ ] Change list of shows to actual list of episodes in the "Continue watching"" section, like it´s done on the website
36 - [ ] Enable possibility to export single episodes or seasons to the Library
37 - [ ] Evaluate idea of an auto updating library exporter that keeps track (on Plugin start/on Service start maybe)
38 - [ ] If a new user has been created, they need to select their movie/show preferences to actually get started, we could provide the same mechanisms in Kodi
39 - [ ] Enable aggressive fetching of data in background (maybe using Futures), like the Netflix website does, to enhance the speed and the user experience when browsing the frontend
40
41 ###Something doesn't work
42 -------------------------
43
44 If something doesn't work for you, please:
45
46 - Make sure all prerequisites are met
47 - Enable verbose logging in the plugin settings
48 - Enable the Debug log in you Kodi settings
49 - Open an issue with a titles that summarises your problems and include:
50         - Kodi version (git sha as long as we´re on agile only)
51         - Inputstream.adaptive version (git sha as long as we´re on the agile branch)
52         - Your OS and OS version
53         - Libwedevine version
54         - A Kodi debug log that represents your issue
55
56 ###Licence
57 -----------------
58
59 Licenced under The MIT License.
60 Includes [pyjsparser](https://github.com/PiotrDabkowski/pyjsparser) by [Piotr Dabkowski](https://github.com/PiotrDabkowski)