chore(version): Version bump
[plugin.video.netflix.git] / README.md
index fc797d28c34ee96dc112ef9a49c31bc8b87d7aaf..22fa427950f5807e72b3c75b27998af2c50a1b86 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,65 @@
 # plugin.video.netflix
 
-Einstellungen:
---------------
-
-  - E-Mail/Passwort: Logindaten des Netflix-Accounts
-  - Verbose logging an/aus
-  - Logout (löscht gespeicherte Cookies & Nutzerdaten)
-  - Library Einstellungen
-  - SSL Einstellungen
-
-Funktionen:
------------
-
-  - Wechsel zwischen Profilen
-  - Suche nach Filmen/Serien (inkl. suggestions)
-  - Anzeigen von Kategorien wie "Meine Liste", "Weil Sie x gesehen haben", "Mit dem Profil von x weiterschauen", "Originals" etc.
-  - Eingabe von "Adult Pin" bei FSK 18 Filmen/Serien
-  - Rating aus Kodi in Netflix  
-  - Einträge auf Netflix in Watchlist (Meine Liste) hinzufügen/entfernen
-  - Export in lokale Library (Filme & komplette shows - keine einzelnen Staffeln oder einzelnen Episoden)
-
-ToDo:
------
-
-  - Fehlende Daten (Cast, bookmark position, etc.) den Show items in der Serien Video Liste hinzufügen
-  - Mit dem Profil von "x" weiterschauen - Statt der Liste der Shows direkt die Episode mit Bookmark anzeigen
+## Netflix Plugin for Kodi 18
+
+<span class="badge-bitcoin"><a href="https://blockchain.info/address/1DHGftMkFXXsDY7UnqQuatWwxQzKVu88sF" title="Donate to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+
+Disclaimer
+-------------
+This plugin is not officially commisioned/supported by Netflix.
+The trademark "Netflix" is registered by "Netflix, Inc."
+
+Prerequisites
+-------------
+
+- Kodi 18 [nightlybuild](http://mirrors.kodi.tv/nightlies/)
+- Inputstream.adaptive [>=v2.0.4](https://github.com/peak3d/inputstream.adaptive) (should be included in your Kodi 18 installation)
+- 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/))
+
+Installation & Updates
+----------------------
+
+You can use [our repository](https://github.com/kodinerds/repo/raw/master/repository.netflix/repository.netflix-1.0.1.zip) to install plugin. Using this, you´ll immediately receive updates once a new release has been drafted.
+
+FAQ
+---
+
+- [Does it work with Kodi 17](https://github.com/asciidisco/plugin.video.netflix/issues/25)
+- [Does it work on a RPI](https://github.com/asciidisco/plugin.video.netflix/issues/28)
+- [Which video resolutions are supported](https://github.com/asciidisco/plugin.video.netflix/issues/27)
+
+Functionality
+-------------
+- Multiple profiles
+- Search Netflix (incl. suggestions)
+- Netflix categories, recommendations, "my list" & continue watching
+- Rate show/movie
+- Add & remove to/from "my list"
+- 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` )
+
+Something doesn't work
+----------------------
+
+If something doesn't work for you, please:
+
+- Make sure all prerequisites are met
+- Enable verbose logging in the plugin settings
+- Enable the Debug log in you Kodi settings
+- Open an issue with a titles that summarises your problems and include:
+       - Kodi version (git sha if possible)
+       - Inputstream.adaptive version (git sha if possible)
+       - Your OS and OS version
+       - Libwedevine version
+       - A Kodi debug log that represents your issue
+
+Donate
+------
+
+If you like this project feel free to buy us some cups of coffee.
+Our bitcoin address is: `1DHGftMkFXXsDY7UnqQuatWwxQzKVu88sF`
+
+Licence
+-------
+
+Licenced under The MIT License.
+Includes [pyjsparser](https://github.com/PiotrDabkowski/pyjsparser) by [Piotr Dabkowski](https://github.com/PiotrDabkowski)